blob: c868c3f2f9a0ab97009f4a569e0077345a9330b5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2014 Zbigniew Jędrzejewski-Szmek
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="sd_bus_label_escape">
<refentryinfo>
<title>sd_bus_label_escape</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>A monkey with a typewriter</contrib>
<firstname>Zbigniew</firstname>
<surname>Jędrzejewski-Szmek</surname>
<email>zbyszek@in.waw.pl</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>sd_bus_label_escape</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_bus_label_escape</refname>
<refname>sd_bus_label_unescape</refname>
<refpurpose>Escape D-Bus object path special characters</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
<funcprototype>
<funcdef>char* <function>sd_bus_label_escape</function></funcdef>
<paramdef>const char* <parameter>s</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>char* <function>sd_bus_label_unescape</function></funcdef>
<paramdef>const char* <parameter>f</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_bus_label_escape()</function> takes a
<constant>NUL</constant>-terminated string as a argument. It will
replace all characters which are invalid in a D-Bus object path by
<literal>_</literal> and a hexadecimal number. As a special case,
the empty string will be replaced by a lone <literal>_</literal>.
<function>sd_bus_label_unescape()</function> can be used to
reverse this process.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
<para>On success, a new <constant>NUL</constant>-terminated string
will be returned. It must be
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>d
by the caller. If a memory allocation failure occurs,
<constant>NULL</constant> will be returned.
</para>
</refsect1>
<refsect1>
<title>Notes</title>
<para><function>sd_bus_label_escape()</function> and
<function>sd_bus_label_unescape()</function> are available as a
shared library, which can be compiled and linked to with the
<constant>libsystemd-bus</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
