1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
8 Copyright © 2014 Zbigniew Jędrzejewski-Szmek
11 <refentry id="sd_bus_message_append_string_memfd"
12 xmlns:xi="http://www.w3.org/2001/XInclude">
15 <title>sd_bus_message_append_string_memfd</title>
16 <productname>elogind</productname>
20 <refentrytitle>sd_bus_message_append_string_memfd</refentrytitle>
21 <manvolnum>3</manvolnum>
25 <refname>sd_bus_message_append_string_memfd</refname>
26 <refname>sd_bus_message_append_string_iovec</refname>
27 <refname>sd_bus_message_append_string_space</refname>
29 <refpurpose>Attach a string to a message</refpurpose>
34 <funcsynopsisinfo>#include <elogind/sd-bus.h></funcsynopsisinfo>
37 <funcdef>int sd_bus_message_append_string_memfd</funcdef>
38 <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
39 <paramdef>int <parameter>memfd</parameter></paramdef>
43 <funcdef>int sd_bus_message_append_string_iovec</funcdef>
44 <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
45 <paramdef>const struct iovec *<parameter>iov</parameter></paramdef>
46 <paramdef>unsigned <parameter>n</parameter></paramdef>
50 <funcdef>int sd_bus_message_append_string_space</funcdef>
51 <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
52 <paramdef>size_t <parameter>size</parameter></paramdef>
53 <paramdef>char **<parameter>s</parameter></paramdef>
59 <title>Description</title>
62 <function>sd_bus_message_append_string_memfd</function> and
63 <function>sd_bus_message_append_string_iovec</function> can be
64 used to append a single string (item of type <literal>s</literal>)
65 to message <parameter>m</parameter>.</para>
68 <function>sd_bus_message_append_string_memfd</function>, the
69 contents of <parameter>memfd</parameter> are the string. They must
70 satisfy the same constraints as described for the
71 <literal>s</literal> type in
72 <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
75 <function>sd_bus_message_append_string_iovec</function>, the
76 payload of <parameter>iov</parameter> is the string. It must
77 satisfy the same constraints as described for the
78 <literal>s</literal> type in
79 <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
81 <para>The <parameter>iov</parameter> argument must point to
82 <parameter>n</parameter> <structname>struct iovec</structname>
83 structures. Each structure may have the
84 <structname>iov_base</structname> field set, in which case the
85 memory pointed to will be copied into the message, or unset, in
86 which case a block of spaces (ASCII 32) of length
87 <structname>iov_len</structname> will be inserted. The
88 memory pointed at by <parameter>iov</parameter> may be changed
89 after this call.</para>
92 <function>sd_bus_message_append_string_space</function> function appends
93 space for a string to message <parameter>m</parameter>. It behaves
94 similar to <function>sd_bus_message_append_basic</function> with
95 type <literal>s</literal>, but instead of copying a string into
96 the message, it returns a pointer to the destination area to
97 the caller in pointer <parameter>p</parameter>. Space for the string
98 of length <parameter>size</parameter> plus the terminating
99 <constant>NUL</constant> is allocated.</para>
103 <title>Return Value</title>
105 <para>On success, those calls return 0 or a positive integer. On
106 failure, they returns a negative errno-style error code.</para>
109 <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
111 <xi:include href="libelogind-pkgconfig.xml" />
114 <title>See Also</title>
117 <!-- 0 /// elogind is in section 8
118 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
120 <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
122 <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
123 <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
124 <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink>