diff --git a/man/rules/meson.build b/man/rules/meson.build index 12c2b92b29..6f14918821 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -293,6 +293,7 @@ manpages = [ ['sd_bus_set_sender', '3', ['sd_bus_get_sender'], ''], ['sd_bus_set_watch_bind', '3', ['sd_bus_get_watch_bind'], ''], ['sd_bus_slot_ref', '3', ['sd_bus_slot_unref', 'sd_bus_slot_unrefp'], ''], + ['sd_bus_slot_set_description', '3', ['sd_bus_slot_get_description'], ''], ['sd_bus_slot_set_destroy_callback', '3', ['sd_bus_destroy_t', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index a1f1ecb956..b2cf306993 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -80,6 +80,7 @@ sd_bus_set_description3, sd_bus_set_sender3, sd_bus_set_watch_bind3 +sd_bus_slot_set_description3, sd_bus_slot_set_destroy_callback3, sd_bus_slot_set_floating3, sd_bus_slot_set_userdata3, diff --git a/man/sd_bus_slot_set_description.xml b/man/sd_bus_slot_set_description.xml new file mode 100644 index 0000000000..4bcb1e3611 --- /dev/null +++ b/man/sd_bus_slot_set_description.xml @@ -0,0 +1,109 @@ + + + + + + + sd_bus_slot_set_description + systemd + + + + sd_bus_slot_set_description + 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 + + + + + + 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. + + + + + Return Value + + 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. + + + + + + + + + See Also + + + systemd1, + sd-bus3 + sd_bus_slot_ref3, + sd_bus_slot_set_userdata3 + + + +