sd_bus_interface_name_is_valid(3) — Linux manual page

SD_BUS_...S_VALID(3) sd_bus_interface_name_is_valid SD_BUS_...S_VALID(3)

NAME

       sd_bus_interface_name_is_valid, sd_bus_service_name_is_valid,
       sd_bus_member_name_is_valid, sd_bus_object_path_is_valid - Check
       if a string is a valid bus name or object path

SYNOPSIS

       #include <systemd/sd-bus.h>

       int sd_bus_interface_name_is_valid(const char* p);

       int sd_bus_service_name_is_valid(const char* p);

       int sd_bus_member_name_is_valid(const char* p);

       int sd_bus_object_path_is_valid(const char* p);

DESCRIPTION

       sd_bus_interface_name_is_valid() checks if a given string p is a
       syntactically valid bus interface name. Similarly,
       sd_bus_service_name_is_valid() checks if the argument is a valid
       bus service name, sd_bus_member_name_is_valid() checks if the
       argument is a valid bus interface member name, and
       sd_bus_object_path_is_valid() checks if the argument is a valid
       bus object path. Those functions generally check that only
       allowed characters are used and that the length of the string is
       within limits.

RETURN VALUE

       Those functions return 1 if the argument is a valid interface /
       service / member name or object path, and 0 if it is not. If the
       argument is NULL, an error is returned.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           The p parameter is NULL.

NOTES

       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

       sd_bus_interface_name_is_valid(), sd_bus_service_name_is_valid(),
       sd_bus_member_name_is_valid(), and sd_bus_object_path_is_valid()
       were added in version 246.

SEE ALSO

       systemd(1), sd-bus(3), sd_bus_call_method(3)

COLOPHON

       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 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  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 257~devel                                   SD_BUS_...S_VALID(3)

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

---