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
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   Copyright © 2014 Zbigniew Jędrzejewski-Szmek
   9 -->
  10
  11 <refentry id="sd_bus_message_append_strv"
  12           xmlns:xi="http://www.w3.org/2001/XInclude">
  13
  14   <refentryinfo>
  15     <title>sd_bus_message_append_strv</title>
  16     <productname>systemd</productname>
  17
  18     <authorgroup>
  19       <author>
  20         <contrib>A monkey with a typewriter</contrib>
  21         <firstname>Zbigniew</firstname>
  22         <surname>Jędrzejewski-Szmek</surname>
  23         <email>zbyszek@in.waw.pl</email>
  24       </author>
  25     </authorgroup>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle>sd_bus_message_append_strv</refentrytitle>
  30     <manvolnum>3</manvolnum>
  31   </refmeta>
  32
  33   <refnamediv>
  34     <refname>sd_bus_message_append_strv</refname>
  35
  36     <refpurpose>Attach an array of strings to a message</refpurpose>
  37   </refnamediv>
  38
  39   <refsynopsisdiv>
  40     <funcsynopsis>
  41       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
  42
  43       <funcprototype>
  44         <funcdef>int sd_bus_message_append_strv</funcdef>
  45         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
  46         <paramdef>char **<parameter>l</parameter></paramdef>
  47       </funcprototype>
  48     </funcsynopsis>
  49   </refsynopsisdiv>
  50
  51   <refsect1>
  52     <title>Description</title>
  53
  54     <para>The <function>sd_bus_message_append</function> function can be
  55     used to append an array of strings to message
  56     <parameter>m</parameter>. The parameter <parameter>l</parameter>
  57     shall point to a <constant>NULL</constant>-terminated array of pointers
  58     to <constant>NUL</constant>-terminated strings. Each string must
  59     satisfy the same constraints as described for the
  60     <literal>s</literal> type in
  61     <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  62     </para>
  63
  64     <para>The memory pointed at by <parameter>p</parameter> and the
  65     contents of the strings themselves are copied into the memory area
  66     containing the message and may be changed after this call. Note
  67     that the signature of <parameter>l</parameter> parameter is to be
  68     treated as <type>const char *const *</type>, and the contents
  69     will not be modified.</para>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>Return Value</title>
  74
  75     <para>On success, this call returns 0 or a positive integer. On
  76     failure, a negative errno-style error code is returned.</para>
  77   </refsect1>
  78
  79   <xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
  80
  81   <xi:include href="libsystemd-pkgconfig.xml" />
  82
  83   <refsect1>
  84     <title>See Also</title>
  85
  86     <para>
  87       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  88       <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  89       <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  90       <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
  91       <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink>
  92     </para>
  93   </refsect1>
  94
  95 </refentry>