]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
Merge pull request #15519 from DaanDeMeyer/sd-bus-message-read-strv-docs
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 22 Apr 2020 07:43:54 +0000 (09:43 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Wed, 22 Apr 2020 07:44:27 +0000 (09:44 +0200)
1  2 
man/sd_bus_message_read_strv.xml

index 0000000000000000000000000000000000000000,737484383230f5754bb940a2ff939a0d90892d10..a86bbe45d8911bb9cea4e547d5410a115248fb97
mode 000000,100644..100644
--- /dev/null
@@@ -1,0 -1,90 +1,90 @@@
 -    success, A pointer to the <constant>NULL</constant>-terminated array of strings is returned in the output
+ <?xml version='1.0'?>
+ <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ <!-- SPDX-License-Identifier: LGPL-2.1+ -->
+ <refentry id="sd_bus_message_read_strv">
+   <refentryinfo>
+     <title>sd_bus_message_read_strv</title>
+     <productname>systemd</productname>
+   </refentryinfo>
+   <refmeta>
+     <refentrytitle>sd_bus_message_read_strv</refentrytitle>
+     <manvolnum>3</manvolnum>
+   </refmeta>
+   <refnamediv>
+     <refname>sd_bus_message_read_strv</refname>
+     <refpurpose>Access an array of strings in a message</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+     <funcsynopsis>
+       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+       <funcprototype>
+         <funcdef>int <function>sd_bus_message_read_strv</function></funcdef>
+         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
+         <paramdef>char ***<parameter>l</parameter></paramdef>
+       </funcprototype>
+     </funcsynopsis>
+   </refsynopsisdiv>
+   <refsect1>
+     <title>Description</title>
+     <para><function>sd_bus_message_read_strv()</function> gives access to an array of strings in message
+     <parameter>m</parameter>. The "read pointer" in the message must be right before an array of strings. On
++    success, a pointer to the <constant>NULL</constant>-terminated array of strings is returned in the output
+     parameter <parameter>l</parameter>. Note that ownership of this array is transferred to the caller.
+     Hence, the caller is responsible for freeing this array and its contents.</para>
+   </refsect1>
+   <refsect1>
+     <title>Return Value</title>
+     <para>On success, <function>sd_bus_message_read_strv()</function> returns a non-negative integer. On
+     failure, it returns a negative errno-style error code.</para>
+     <refsect2>
+       <title>Errors</title>
+       <para>Returned errors may indicate the following problems:</para>
+       <variablelist>
+         <varlistentry>
+           <term><constant>-EINVAL</constant></term>
+           <listitem><para><parameter>m</parameter> or <parameter>l</parameter> are <constant>NULL</constant>.
+           </para></listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><constant>-EPERM</constant></term>
+           <listitem><para>The message is not sealed.</para></listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><constant>-EBADMSG</constant></term>
+           <listitem><para>The message cannot be parsed.</para></listitem>
+         </varlistentry>
+       </variablelist>
+     </refsect2>
+   </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_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+     </para>
+   </refsect1>
+ </refentry>