mirror of
https://github.com/systemd/systemd.git
synced 2024-12-26 03:22:00 +03:00
117 lines
4.3 KiB
XML
117 lines
4.3 KiB
XML
<?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.
|
||
|
||
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_message_append_strv" conditional="ENABLE_KDBUS"
|
||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||
|
||
<refentryinfo>
|
||
<title>sd_bus_message_append_strv</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_strv</refentrytitle>
|
||
<manvolnum>3</manvolnum>
|
||
</refmeta>
|
||
|
||
<refnamediv>
|
||
<refname>sd_bus_message_append_strv</refname>
|
||
|
||
<refpurpose>Attach an array of strings to a message</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsynopsisdiv>
|
||
<funcsynopsis>
|
||
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
||
|
||
<funcprototype>
|
||
<funcdef>int sd_bus_message_append_strv</funcdef>
|
||
<paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
|
||
<paramdef>char **<parameter>l</parameter></paramdef>
|
||
</funcprototype>
|
||
</funcsynopsis>
|
||
</refsynopsisdiv>
|
||
|
||
<refsect1>
|
||
<title>Description</title>
|
||
|
||
<para>The <function>sd_bus_message_append</function> function can be
|
||
used to append an array of strings to message
|
||
<parameter>m</parameter>. The parameter <parameter>l</parameter>
|
||
shall point to a <constant>NULL</constant>-terminated array of pointers
|
||
to <constant>NUL</constant>-terminated strings. Each string 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>The memory pointed at by <parameter>p</parameter> and the
|
||
contents of the strings themselves are copied into the memory area
|
||
containing the message and may be changed after this call. Note
|
||
that the signature of <parameter>l</parameter> parameter is to be
|
||
treated as <type>const char *const *</type>, and the contents
|
||
will not be modified.</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Return Value</title>
|
||
|
||
<para>On success, this call returns 0 or a positive integer. On
|
||
failure, a negative errno-style error code is returned.</para>
|
||
</refsect1>
|
||
|
||
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
|
||
|
||
<refsect1>
|
||
<title>Notes</title>
|
||
|
||
<para>The <function>sd_bus_append_append_strv()</function> function
|
||
described here is available as a shared library, which can be
|
||
compiled and linked to with the
|
||
<constant>libsystemd</constant> <citerefentry project='die-net'><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>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||
<citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||
<ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink>
|
||
</para>
|
||
</refsect1>
|
||
|
||
</refentry>
|