-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!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.
+ This file is part of systemd.
-Copyright 2014 Zbigniew Jędrzejewski-Szmek
+ 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 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.
+ 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/>.
+ 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_message_append_array" conditional="ENABLE_KDBUS"
<funcdef>int sd_bus_message_append_array_memfd</funcdef>
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
<paramdef>char <parameter>type</parameter></paramdef>
- <paramdef>
sd_memfd *<parameter>memfd</parameter></paramdef>
+ <paramdef>
int <parameter>memfd</parameter></paramdef>
</funcprototype>
<funcprototype>
<refsect1>
<title>Description</title>
- <para>Function <function>sd_bus_message_append_array</function>
+ <para>The <function>sd_bus_message_append_array</function> functionc
appends items to message <parameter>m</parameter> as the single
array. A container will be opened, items appended, and the
container closed. Parameter <parameter>type</parameter> determines
<ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#basic-types">Basic Types</ulink>
section of the D-Bus specification, and listed in
<citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
- Pointer <parameter>p</parameter> must point to an array of of size
+ Pointer <parameter>p</parameter> must point to an array of size
<parameter>size</parameter> bytes containing items of the
respective type. Size <parameter>size</parameter> must be a
multiple of the size of the type <parameter>type</parameter>. As a
into the memory area containing the message and may be changed
after this call.</para>
- <para>Function
- <function>sd_bus_message_append_array_memfd</function> appends
+ <para>The
+ <function>sd_bus_message_append_array_memfd</function> function appends
items to message <parameter>m</parameter>, similarly to
<function>sd_bus_message_append_array</function>. Contents of the
memory file descriptor <parameter>memfd</parameter> are used as
the contents of the array. Their size must be a multiple of the
size of the type <parameter>type</parameter>.</para>
- <para>Descriptor <parameter>memfd</parameter> will be sealed
- and cannot be modified after this call.</para>
+ <para>The descriptor specified with <parameter>memfd</parameter>
+ will be sealed and cannot be modified after this call.</para>
- <para>Function
- <function>sd_bus_message_append_array_iovec</function> appends
+ <para>The
+ <function>sd_bus_message_append_array_iovec</function> function appends
items to message <parameter>m</parameter>, similarly to
<function>sd_bus_message_append_array</function>. Contents of the
iovec <parameter>iov</parameter> are used as the contents of the
sum of <structfield>iov_len</structfield> fields) must be a multiple
of the size of the type <parameter>type</parameter>.</para>
- <para>Pointer <parameter>iov</parameter> must point to
+ <para>The <parameter>iov</parameter> argument must point to
<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 at by <parameter>iov</parameter> may be changed
after this call.</para>
- <para>Function
- <function>sd_bus_message_append_array_space</function> appends
+ <para>The
+ <function>sd_bus_message_append_array_space</function> function appends
space for an array of items to message <parameter>m</parameter>.
It behaves the same as
<function>sd_bus_message_append_array</function>, but instead
<refsect1>
<title>Return Value</title>
- <para>On success, those calls return 0 or a positive integer. On
+ <para>On success, these calls return 0 or a positive integer. On
failure, they returns a negative errno-style error code.</para>
</refsect1>
<para><function>sd_bus_append_array()</function> and other
functions described here are available as a shared library, which
can be compiled and linked to with the
- <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1>
~ianmdlvl / elogind.git / blobdiff