sd_bus_interface_name_is_valid(3) — Chainguard OS Manuals

SD_BUS_INTERFACE_NAME_IS_VALID(3)

sd_bus_interface_name_is_valid

SD_BUS_INTERFACE_NAME_IS_VALID(3)

.SH "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

.SH "SYNOPSIS"

#include <systemd/sd-bus.h>

.HP 840u int sd_bus_interface_name_is_valid(const char* p);

.HP 792u int sd_bus_service_name_is_valid(const char* p);

.HP 768u int sd_bus_member_name_is_valid(const char* p);

.HP 768u int sd_bus_object_path_is_valid(const char* p);

.SH "DESCRIPTION"

.PP 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.

.SH "RETURN VALUE"

.PP 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.

.SS "Errors"

.PP Returned errors may indicate the following problems:

.PP -EINVAL

The p parameter is NULL.

.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_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.

systemd 262.2