man/sd_bus_message_append_strv.xml

   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" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2014 Zbigniew Jędrzejewski-Szmek
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="sd_bus_message_append_strv"
  28           xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>sd_bus_message_append_strv</title>
  32     <productname>systemd</productname>
  33
  34     <authorgroup>
  35       <author>
  36         <contrib>A monkey with a typewriter</contrib>
  37         <firstname>Zbigniew</firstname>
  38         <surname>Jędrzejewski-Szmek</surname>
  39         <email>zbyszek@in.waw.pl</email>
  40       </author>
  41     </authorgroup>
  42   </refentryinfo>
  43
  44   <refmeta>
  45     <refentrytitle>sd_bus_message_append_strv</refentrytitle>
  46     <manvolnum>3</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>sd_bus_message_append_strv</refname>
  51
  52     <refpurpose>Attach an array of strings to a message</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <funcsynopsis>
  57       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
  58
  59       <funcprototype>
  60         <funcdef>int sd_bus_message_append_strv</funcdef>
  61         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
  62         <paramdef>char **<parameter>l</parameter></paramdef>
  63       </funcprototype>
  64     </funcsynopsis>
  65   </refsynopsisdiv>
  66
  67   <refsect1>
  68     <title>Description</title>
  69
  70     <para>The <function>sd_bus_message_append</function> function can be
  71     used to append an array of strings to message
  72     <parameter>m</parameter>. The parameter <parameter>l</parameter>
  73     shall point to a <constant>NULL</constant>-terminated array of pointers
  74     to <constant>NUL</constant>-terminated strings. Each string must
  75     satisfy the same constraints as described for the
  76     <literal>s</literal> type in
  77     <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  78     </para>
  79
  80     <para>The memory pointed at by <parameter>p</parameter> and the
  81     contents of the strings themselves are copied into the memory area
  82     containing the message and may be changed after this call. Note
  83     that the signature of <parameter>l</parameter> parameter is to be
  84     treated as <type>const char *const *</type>, and the contents
  85     will not be modified.</para>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>Return Value</title>
  90
  91     <para>On success, this call returns 0 or a positive integer. On
  92     failure, a negative errno-style error code is returned.</para>
  93   </refsect1>
  94
  95   <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
  96
  97   <refsect1>
  98     <title>Notes</title>
  99
 100     <para>The <function>sd_bus_append_append_strv()</function> function
 101     described here is available as a shared library, which can be
 102     compiled and linked to with the
 103     <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 104     file.</para>
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>See Also</title>
 109
 110     <para>
 111       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 112       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 113       <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 114       <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 115       <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink>
 116     </para>
 117   </refsect1>
 118
 119 </refentry>