diff options
| author | Lennart Poettering <lennart@poettering.net> | 2020-01-28 16:52:12 +0100 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2020-01-28 16:52:15 +0100 |
| commit | e0db55a643f230e9c5dbadd21649cb1199ccd185 (patch) | |
| tree | 3eb963df95bf3dc44391868366ae0bcaf528c8ab | |
| parent | 10c238b2cc4a1346bec492ce802fa4e0fa92706d (diff) | |
| download | systemd-e0db55a643f230e9c5dbadd21649cb1199ccd185.tar.gz | |
man: document that sd_bus_message_read_array() only supports trivial types
Fixes: #14641
| -rw-r--r-- | man/sd_bus_message_read_array.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/man/sd_bus_message_read_array.xml b/man/sd_bus_message_read_array.xml index 117afa9e31..26e8ebae60 100644 --- a/man/sd_bus_message_read_array.xml +++ b/man/sd_bus_message_read_array.xml @@ -48,6 +48,10 @@ appropriate for the data type. The data is part of the message — it may not be modified and is valid only as long as the message is referenced. After this function returns, the "read pointer" points at the next element after the array.</para> + + <para>Note that this function only supports arrays of trivial types, i.e. arrays of booleans, the various + integer types, as well as floating point numbers. In particular it may not be used for arrays of strings, + structures or similar.</para> </refsect1> <refsect1> @@ -68,8 +72,8 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>Specified type is invalid or the message parameter or one of the output - parameters are <constant>NULL</constant>.</para></listitem> + <listitem><para>Specified type is invalid or not a trivial type (see above), or the message + parameter or one of the output parameters are <constant>NULL</constant>.</para></listitem> </varlistentry> <varlistentry> |