diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-02-05 15:22:42 +0100 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-02-12 11:36:24 +0100 |
| commit | 63ab06c4d281046b4a2424b6accd407470c91eb5 (patch) | |
| tree | b30808c6230bd82d1317f0867a908140b88d901b /man/sd_bus_message_read_strv.xml | |
| parent | fa7924db0bd836e30021c9b2c0480f0beb1a85d6 (diff) | |
| download | systemd-63ab06c4d281046b4a2424b6accd407470c91eb5.tar.gz | |
sd-bus: extend sd_bus_message_read_strv() to paths and signatures
It's rather convenient to be able to read all three types with this function.
Strictly speaking this change is not fully compatible, in case someone was
relying on sd_bus_message_read_strv() returning an error for anything except
"as", but I hope nobody was doing that.
Diffstat (limited to 'man/sd_bus_message_read_strv.xml')
| -rw-r--r-- | man/sd_bus_message_read_strv.xml | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/man/sd_bus_message_read_strv.xml b/man/sd_bus_message_read_strv.xml index a90ae84098..50580d86bc 100644 --- a/man/sd_bus_message_read_strv.xml +++ b/man/sd_bus_message_read_strv.xml @@ -36,11 +36,13 @@ <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> + <para><function>sd_bus_message_read_strv()</function> gives access to an array of string-like items in + message <parameter>m</parameter>. The "read pointer" in the message must be right before an array of + strings (D-Bus type <literal>as</literal>), object paths (D-Bus type <literal>ao</literal>), or + signatures (D-Bus type <literal>ag</literal>). On success, a pointer to a + <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> @@ -73,6 +75,13 @@ <listitem><para>The message cannot be parsed.</para></listitem> </varlistentry> + + <varlistentry> + <term><constant>-ENXIO</constant></term> + + <listitem><para>The message "read pointer" is not right before an array of the appropriate type. + </para></listitem> + </varlistentry> </variablelist> </refsect2> </refsect1> |