sd_bus_list_names(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | HISTORY | SEE ALSO | NOTES | COLOPHON

SD_BUS_LIST_NAMES(3)        sd_bus_list_names       SD_BUS_LIST_NAMES(3)

NAME         top

       sd_bus_list_names - Retrieve information about registered names
       on a bus

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_list_names(sd_bus *bus, char ***acquired,
                             char ***activatable);

DESCRIPTION         top

       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 acquired is not NULL, the
       function calls org.freedesktop.DBus.ListActivableNames[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.

RETURN VALUE         top

       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.

           Added in version 246.

       -ENOPKG
           The bus cannot be resolved.

           Added in version 246.

       -ECHILD
           The bus was created in a different process, library or module
           instance.

           Added in version 246.

       -ENOMEM
           Memory allocation failed.

           Added in version 246.

       -ENOTCONN
           The bus is not connected.

           Added in version 246.

NOTES         top

       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.

HISTORY         top

       sd_bus_list_names() was added in version 246.

SEE ALSO         top

       systemd(1), sd-bus(3)

NOTES         top

        1. org.freedesktop.DBus.ListNames
           https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-names

        2. org.freedesktop.DBus.ListActivableNames
           https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-activatable-names

COLOPHON         top

       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 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  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 255                                         SD_BUS_LIST_NAMES(3)

Pages that refer to this page: sd-bus(3)systemd.directives(7)systemd.index(7)