|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | HISTORY | SEE ALSO | COLOPHON |
|
|
|
SD_BUS_...CRIPTION(3) sd_bus_slot_set_description SD_BUS_...CRIPTION(3)
sd_bus_slot_set_description, sd_bus_slot_get_description - Set or
query the description of bus slot objects
#include <systemd/sd-bus.h>
int sd_bus_slot_set_description(sd_bus_slot* slot,
const char *description);
int sd_bus_slot_get_description(sd_bus_slot* bus,
const char **description);
sd_bus_slot_set_description() sets the description string that is
used in logging to the specified string. The string is copied
internally and freed when the bus slot object is deallocated. The
description argument may be NULL, in which case the description is
unset.
sd_bus_slot_get_description() returns a description string in
description. If the string is not set, e.g. with
sd_bus_slot_set_description(), and the slot is a bus match
callback slot, the match string will be returned. Otherwise,
-ENXIO is returned.
On success, these functions return 0 or a positive integer. On
failure, they return a negative errno-style error code.
Errors
Returned errors may indicate the following problems:
-EINVAL
An required argument is NULL.
-ENXIO
The bus slot object has no description.
-ENOMEM
Memory allocation failed.
Functions described here are available as a shared library, which
can be compiled against and linked to with the
libsystemd pkg-config(1) file.
The code described here uses getenv(3), which is declared to be
not multi-thread-safe. This means that the code calling the
functions described here must not call setenv(3) from a parallel
thread. It is recommended to only do calls to setenv() from an
early phase of the program when no other threads have been
started.
sd_bus_slot_set_description() and sd_bus_slot_get_description()
were added in version 240.
systemd(1), sd-bus(3), sd_bus_slot_ref(3),
sd_bus_slot_set_userdata(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 2025-08-11. (At that
time, the date of the most recent commit that was found in the
repository was 2025-08-11.) If you discover 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 258~rc2 SD_BUS_...CRIPTION(3)
Pages that refer to this page: sd-bus(3), systemd.directives(7), systemd.index(7)