| SD_BUS_LIST_NAMES(3) | sd_bus_list_names | SD_BUS_LIST_NAMES(3) |
.SH "NAME" sd_bus_list_names - Retrieve information about
registered names on a bus
.SH "SYNOPSIS"
#include <systemd/sd-bus.h>
.HP 528u int sd_bus_list_names(sd_bus *bus,
char ***acquired,
char ***activatable);
.SH "DESCRIPTION"
.PP 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[1] to retrieve the list of
currently-owned names on the bus. If activatable is not NULL,
the function calls org.freedesktop.DBus.ListActivatableNames[2] to
retrieve the list of all names on the bus that can be activated. Note that
ownership of the arrays returned by sd_bus_list_names() in
acquired and activatable is transferred to the caller and
hence, the caller is responsible for freeing these arrays and their
contents.
.SH "RETURN VALUE"
.PP On success, sd_bus_list_names() returns a non-negative integer. On
failure, it returns a negative errno-style error code.
.SS "Errors"
.PP Returned errors may indicate the following problems:
.PP -EINVAL
bus or both acquired and activatable were
NULL.
.RE
.PP -ENOPKG
The bus cannot be resolved.
.RE
.PP -ECHILD
The bus was created in a different process, library or module instance.
.RE
.PP -ENOMEM
Memory allocation failed.
.RE
.PP -ENOTCONN
The bus is not connected.
.RE
.SH "NOTES"
.PP Functions described here are available as a shared library, which can be
compiled against and linked to with the
libsystemd pkg-config(1) file.
.PP All functions listed here are thread-agnostic and only a single thread
may operate on a given object at any given time. Different threads may
access the same object at different times. Multiple independent objects may
be used from different threads in parallel.
.PP 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.
.SH "HISTORY"
.PP sd_bus_list_names() was added in version 221.
.SH "SEE ALSO"
.PP systemd(1), sd-bus(3)
NOTES
- 1.
- org.freedesktop.DBus.ListNames
- 2.
- org.freedesktop.DBus.ListActivatableNames
| systemd 262.2 |