diff --git a/man/rules/meson.build b/man/rules/meson.build index 222c0d2919b..f11382ab83e 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -263,6 +263,7 @@ manpages = [ ''], ['sd_bus_get_n_queued_read', '3', ['sd_bus_get_n_queued_write'], ''], ['sd_bus_is_open', '3', ['sd_bus_is_ready'], ''], + ['sd_bus_list_names', '3', [], ''], ['sd_bus_message_append', '3', ['sd_bus_message_appendv'], ''], ['sd_bus_message_append_array', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 9918e0c737b..e8792cd6c94 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -86,6 +86,7 @@ sd_bus_get_unique_name3, sd_bus_is_bus_client3, sd_bus_is_server3, +sd_bus_list_names3, sd_bus_message_append3, sd_bus_message_append_array3, sd_bus_message_append_basic3, diff --git a/man/sd_bus_list_names.xml b/man/sd_bus_list_names.xml new file mode 100644 index 00000000000..d1aba6ef522 --- /dev/null +++ b/man/sd_bus_list_names.xml @@ -0,0 +1,111 @@ + + + + + + + + sd_bus_list_names + systemd + + + + sd_bus_list_names + 3 + + + + sd_bus_list_names + + Retrieve information about registered names on a bus + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_list_names + sd_bus *bus + char ***acquired + char ***activatable + + + + + + Description + + sd_bus_list_names() retrieves information about the registered names on a bus. + If acquired is not NULL, this function calls + + org.freedesktop.DBus.ListNames to retrieve the list of currently-owned names on the bus. If + acquired is not NULL, the function calls + + org.freedesktop.DBus.ListActivableNames to retrieve the list of all names on the bus that can be + activated. Note that ownership of any string arrays returned by sd_bus_list_names() + is transferred to the caller and hence, the caller is responsible for freeing any results stored by + sd_bus_list_names() in acquired and + activatable. + + + + Return Value + + On success, sd_bus_list_names() returns a non-negative integer. On failure, + it returns a negative errno-style error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + bus or both acquired and + activatable were NULL. + + + + + -ENOPKG + + The bus cannot be resolved. + + + + -ECHILD + + The bus was created in a different process. + + + + -ENOMEM + + Memory allocation failed. + + + + -ENOTCONN + + The bus is not connected. + + + + + + + + + See Also + + + systemd1, + sd-bus3 + + +