From d30ec1f5df99f18312b4b920b7e62b832387dcc1 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 7 Jan 2014 23:05:17 -0500 Subject: man: document label escaping functions --- man/sd_bus_label_escape.xml | 111 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 man/sd_bus_label_escape.xml (limited to 'man/sd_bus_label_escape.xml') diff --git a/man/sd_bus_label_escape.xml b/man/sd_bus_label_escape.xml new file mode 100644 index 0000000000..c868c3f2f9 --- /dev/null +++ b/man/sd_bus_label_escape.xml @@ -0,0 +1,111 @@ + + + + + + + + + sd_bus_label_escape + systemd + + + + A monkey with a typewriter + Zbigniew + Jędrzejewski-Szmek + zbyszek@in.waw.pl + + + + + + sd_bus_label_escape + 3 + + + + sd_bus_label_escape + sd_bus_label_unescape + + Escape D-Bus object path special characters + + + + + #include <systemd/sd-bus.h> + + + char* sd_bus_label_escape + const char* s + + + + char* sd_bus_label_unescape + const char* f + + + + + + Description + + sd_bus_label_escape() takes a + NUL-terminated string as a argument. It will + replace all characters which are invalid in a D-Bus object path by + _ and a hexadecimal number. As a special case, + the empty string will be replaced by a lone _. + sd_bus_label_unescape() can be used to + reverse this process. + + + + Return Value + + On success, a new NUL-terminated string + will be returned. It must be + free3d + by the caller. If a memory allocation failure occurs, + NULL will be returned. + + + + + Notes + + sd_bus_label_escape() and + sd_bus_label_unescape() are available as a + shared library, which can be compiled and linked to with the + libsystemd-bus pkg-config1 + file. + + + + See Also + + + systemd1, + sd-bus3, + free3 + + + + -- cgit v1.2.3-54-g00ecf