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