2014-11-21 19:44:48 +00:00
|
|
|
|
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
|
2014-03-07 04:24:20 +00:00
|
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
2015-06-18 17:47:44 +00:00
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
2014-03-07 04:24:20 +00:00
|
|
|
|
|
|
|
|
|
<!--
|
2017-11-18 16:22:32 +00:00
|
|
|
|
SPDX-License-Identifier: LGPL-2.1+
|
|
|
|
|
|
2015-03-14 02:26:47 +00:00
|
|
|
|
This file is part of systemd.
|
2014-03-07 04:24:20 +00:00
|
|
|
|
|
2015-03-14 02:26:47 +00:00
|
|
|
|
Copyright 2014 Zbigniew Jędrzejewski-Szmek
|
2014-03-07 04:24:20 +00:00
|
|
|
|
-->
|
|
|
|
|
|
2015-06-17 10:32:33 +00:00
|
|
|
|
<refentry id="sd_bus_message_append_string_memfd"
|
2014-03-07 04:24:20 +00:00
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
|
|
|
|
|
|
<refentryinfo>
|
|
|
|
|
<title>sd_bus_message_append_string_memfd</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_message_append_string_memfd</refentrytitle>
|
|
|
|
|
<manvolnum>3</manvolnum>
|
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>sd_bus_message_append_string_memfd</refname>
|
|
|
|
|
<refname>sd_bus_message_append_string_iovec</refname>
|
|
|
|
|
<refname>sd_bus_message_append_string_space</refname>
|
|
|
|
|
|
|
|
|
|
<refpurpose>Attach a string to a message</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<funcsynopsis>
|
|
|
|
|
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int sd_bus_message_append_string_memfd</funcdef>
|
|
|
|
|
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
2014-08-18 11:28:43 +00:00
|
|
|
|
<paramdef>int <parameter>memfd</parameter></paramdef>
|
2014-03-07 04:24:20 +00:00
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int sd_bus_message_append_string_iovec</funcdef>
|
|
|
|
|
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
|
|
|
|
<paramdef>const struct iovec *<parameter>iov</parameter></paramdef>
|
|
|
|
|
<paramdef>unsigned <parameter>n</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int sd_bus_message_append_string_space</funcdef>
|
|
|
|
|
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
|
|
|
|
<paramdef>size_t <parameter>size</parameter></paramdef>
|
|
|
|
|
<paramdef>char **<parameter>s</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
</funcsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<para>The functions
|
2014-03-07 04:24:20 +00:00
|
|
|
|
<function>sd_bus_message_append_string_memfd</function> and
|
|
|
|
|
<function>sd_bus_message_append_string_iovec</function> can be
|
|
|
|
|
used to append a single string (item of type <literal>s</literal>)
|
|
|
|
|
to message <parameter>m</parameter>.</para>
|
|
|
|
|
|
|
|
|
|
<para>In case of
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<function>sd_bus_message_append_string_memfd</function>, the
|
2014-03-07 04:24:20 +00:00
|
|
|
|
contents of <parameter>memfd</parameter> are the string. They must
|
|
|
|
|
satisfy the same constraints as described for the
|
|
|
|
|
<literal>s</literal> type in
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
|
|
|
|
|
|
|
|
|
|
<para>In case of
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<function>sd_bus_message_append_string_iovec</function>, the
|
2014-03-07 04:24:20 +00:00
|
|
|
|
payload of <parameter>iov</parameter> is the string. It must
|
|
|
|
|
satisfy the same constraints as described for the
|
|
|
|
|
<literal>s</literal> type in
|
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
|
|
|
|
|
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<para>The <parameter>iov</parameter> argument must point to
|
2014-03-07 04:24:20 +00:00
|
|
|
|
<parameter>n</parameter> <structname>struct iovec</structname>
|
|
|
|
|
structures. Each structure may have the
|
|
|
|
|
<structname>iov_base</structname> field set, in which case the
|
|
|
|
|
memory pointed to will be copied into the message, or unset, in
|
|
|
|
|
which case a block of spaces (ASCII 32) of length
|
|
|
|
|
<structname>iov_len</structname> will be inserted. The
|
|
|
|
|
memory pointed at by <parameter>iov</parameter> may be changed
|
|
|
|
|
after this call.</para>
|
|
|
|
|
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<para>The
|
|
|
|
|
<function>sd_bus_message_append_string_space</function> function appends
|
|
|
|
|
space for a string to message <parameter>m</parameter>. It behaves
|
|
|
|
|
similar to <function>sd_bus_message_append_basic</function> with
|
2014-03-07 04:24:20 +00:00
|
|
|
|
type <literal>s</literal>, but instead of copying a string into
|
2014-05-07 23:28:44 +00:00
|
|
|
|
the message, it returns a pointer to the destination area to
|
|
|
|
|
the caller in pointer <parameter>p</parameter>. Space for the string
|
2014-03-07 04:24:20 +00:00
|
|
|
|
of length <parameter>size</parameter> plus the terminating
|
|
|
|
|
<constant>NUL</constant> is allocated.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Return Value</title>
|
|
|
|
|
|
|
|
|
|
<para>On success, those calls return 0 or a positive integer. On
|
|
|
|
|
failure, they returns a negative errno-style error code.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Notes</title>
|
|
|
|
|
|
2014-05-07 23:28:45 +00:00
|
|
|
|
<para>The functions described here are available as a shared library,
|
2014-03-07 04:24:20 +00:00
|
|
|
|
which can be compiled and linked to with the
|
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-07 22:25:54 +00:00
|
|
|
|
<constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
2014-03-07 04:24:20 +00:00
|
|
|
|
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>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|