|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | NOTES | SEE ALSO | COLOPHON |
SD_BUS_ERROR_ADD_MAP(3) sd_bus_error_add_map SD_BUS_ERROR_ADD_MAP(3)
sd_bus_error_add_map, sd_bus_error_map, SD_BUS_ERROR_MAP,
SD_BUS_ERROR_END - Additional sd-dbus error mappings
#include <systemd/sd-bus.h>
typedef struct {
const char *name;
int code;
...
} sd_bus_error_map;
SD_BUS_ERROR_MAP(name, code)
SD_BUS_ERROR_MAP_END
int sd_bus_error_add_map(const sd_bus_map *map);
The sd_bus_error_add_map() call may be used to register additional
mappings for converting D-Bus errors to Linux errno-style errors. The
mappings defined with this call are consulted by calls such as
sd_bus_error_set(3) or sd_bus_error_get_errno(3). By default, a
number of generic, standardized mappings are known, as documented in
sd-bus-errors(3). Use this call to add further, application-specific
mappings.
The function takes a pointer to an array of sd_bus_error_map
structures. A reference to the specified array is added to the lookup
tables for error mappings. Note that the structure is not copied, and
that it is hence essential that the array stays available and
constant during the entire remaining runtime of the process.
The mapping array should be put together with a series of
SD_BUS_ERROR_MAP() macro invocations that take a literal name string
and a (positive) errno-style error number. The last entry of the
array should be an invocation of the SD_BUS_ERROR_MAP_END macro. The
array should not be put together without use of these two macros.
Note that the call is idempotent: it is safe to invoke it multiple
times with the parameter, which will only add the passed mapping
array once.
Note that the memory allocated by this call is not intended to be
freed during the lifetime of the process. It should not be freed
explicitly.
sd_bus_error_add_map() returns a positive value when the new array
was added to the lookup tables. It returns zero when the same array
was already added before. On error, a negative errno-style error code
is returned. See below for known error codes.
Returned errors may indicate the following problems:
-EINVAL
The specified mapping array is invalid.
-ENOMEM
Memory allocation failed.
The various error definitions described here are available as a
shared library, which can be compiled and linked to with the
libsystemd pkg-config(1) file.
systemd(1), sd-bus(3), sd_bus_error(3), sd-bus-errors(3), errno(3),
strerror_r(3)
This page is part of the systemd (systemd system and service manager)
project. Information about the project can be found at
⟨http://www.freedesktop.org/wiki/Software/systemd⟩. If you have a bug
report for this manual page, see
⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩. This
page was obtained from the project's upstream Git repository
⟨https://github.com/systemd/systemd.git⟩ on 2017-07-05. If you dis‐
cover any rendering problems in this HTML version of the page, or you
believe there is a better or more up-to-date source for the page, or
you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
systemd 234 SD_BUS_ERROR_ADD_MAP(3)
Pages that refer to this page: sd-bus(3), sd_bus_error(3), systemd.directives(7), systemd.index(7)