summaryrefslogtreecommitdiff
path: root/man/sd_bus_message_append.xml
diff options
context:
space:
mode:
authorFederico <nierro92@gmail.com>2017-04-25 09:32:24 +0200
committerLennart Poettering <lennart@poettering.net>2017-04-25 09:32:24 +0200
commit19fe49f62cc916f1237ea92a04fc80ee75285dde (patch)
treed14cd80a18a638f5fd4901be14f26221783871dc /man/sd_bus_message_append.xml
parentf847b8b7df1de5686f8cbe5a4944a85dfb303595 (diff)
downloadsystemd-19fe49f62cc916f1237ea92a04fc80ee75285dde.tar.gz
Export sd_bus_message_append_ap. It is renamed to sd_bus_message_appendv to follow systemd naming conventions. (#5753)
Moreover, man page for sd_bus_message_append is updated with reference to new exposed function. Makefile-man is updated too, to reflect new alias.
Diffstat (limited to 'man/sd_bus_message_append.xml')
-rw-r--r--man/sd_bus_message_append.xml21
1 files changed, 19 insertions, 2 deletions
diff --git a/man/sd_bus_message_append.xml b/man/sd_bus_message_append.xml
index 132ce66434..2c28ee7154 100644
--- a/man/sd_bus_message_append.xml
+++ b/man/sd_bus_message_append.xml
@@ -45,6 +45,7 @@
<refnamediv>
<refname>sd_bus_message_append</refname>
+ <refname>sd_bus_message_appendv</refname>
<refpurpose>Attach fields to a D-Bus message based on a type
string</refpurpose>
@@ -60,6 +61,14 @@
<paramdef>const char *<parameter>types</parameter></paramdef>
<paramdef>…</paramdef>
</funcprototype>
+
+ <funcprototype>
+ <funcdef>int sd_bus_message_appendv</funcdef>
+ <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
+ <paramdef>const char *<parameter>types</parameter></paramdef>
+ <paramdef>va_list <parameter>ap</parameter></paramdef>
+ </funcprototype>
+
</funcsynopsis>
</refsynopsisdiv>
@@ -109,6 +118,14 @@
values for each entry matching the element type of
the dictionary entries.</para>
+ <para>The <function>sd_bus_message_appendv()</function> is equivalent to
+ the function <function>sd_bus_message_append()</function>,
+ except that it is called with a <literal>va_list</literal> instead of
+ a variable number of arguments. This function does not call the
+ <function>va_end()</function> macro. Because it invokes the
+ <function>va_arg()</function> macro, the value of ap
+ is undefined after the call.</para>
+
<para>For further details on the D-Bus type system, please consult
the <ulink
url="http://dbus.freedesktop.org/doc/dbus-specification.html#type-system">D-Bus
@@ -238,8 +255,8 @@ sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting>
<refsect1>
<title>Return Value</title>
- <para>On success, this call returns 0 or a positive
- integer. On failure, this call returns a negative
+ <para>On success, these functions return 0 or a positive
+ integer. On failure, these functions return a negative
errno-style error code.</para>
</refsect1>