From 0406d1a843ba38334b8d4d9926cffd11ce4d5586 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Sun, 24 May 2020 14:13:24 +0200 Subject: [PATCH] man: add docs for the new functions --- man/rules/meson.build | 6 ++ man/sd-bus.xml | 1 + man/sd_bus_interface_name_is_valid.xml | 98 ++++++++++++++++++++++++++ 3 files changed, 105 insertions(+) create mode 100644 man/sd_bus_interface_name_is_valid.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index 941e248d72..78440e6e91 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -267,6 +267,12 @@ manpages = [ ['sd_bus_get_n_queued_read', '3', ['sd_bus_get_n_queued_write'], ''], ['sd_bus_get_name_creds', '3', ['sd_bus_get_owner_creds'], ''], ['sd_bus_get_name_machine_id', '3', [], ''], + ['sd_bus_interface_name_is_valid', + '3', + ['sd_bus_member_name_is_valid', + 'sd_bus_object_path_is_valid', + 'sd_bus_service_name_is_valid'], + ''], ['sd_bus_is_open', '3', ['sd_bus_is_ready'], ''], ['sd_bus_list_names', '3', [], ''], ['sd_bus_message_append', '3', ['sd_bus_message_appendv'], ''], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 24999337c8..0938255d5c 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -89,6 +89,7 @@ sd_bus_get_scope3, sd_bus_get_tid3, sd_bus_get_unique_name3, +sd_bus_interface_name_is_valid3, sd_bus_is_monitor3, sd_bus_is_bus_client3, sd_bus_is_server3, diff --git a/man/sd_bus_interface_name_is_valid.xml b/man/sd_bus_interface_name_is_valid.xml new file mode 100644 index 0000000000..73c0ba1bf1 --- /dev/null +++ b/man/sd_bus_interface_name_is_valid.xml @@ -0,0 +1,98 @@ + + + + + + + sd_bus_interface_name_is_valid + systemd + + + + sd_bus_interface_name_is_valid + 3 + + + + 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 + + + + + #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. + + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_call_method3 + + + +