From 55944e5e40b1be2afc4855d8d2baf4b73d1876b5 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 22:49:52 +0200 Subject: Adding upstream version 255.4. Signed-off-by: Daniel Baumann --- man/sd_bus_message_read_array.xml | 121 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 man/sd_bus_message_read_array.xml (limited to 'man/sd_bus_message_read_array.xml') diff --git a/man/sd_bus_message_read_array.xml b/man/sd_bus_message_read_array.xml new file mode 100644 index 0000000..1feec20 --- /dev/null +++ b/man/sd_bus_message_read_array.xml @@ -0,0 +1,121 @@ + + + + + + + + sd_bus_message_read_array + systemd + + + + sd_bus_message_read_array + 3 + + + + sd_bus_message_read_array + + Access an array of elements in a message + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_message_read_array + sd_bus_message *m + char type + const void **ptr + size_t *size + + + + + + Description + + sd_bus_message_read_array() provides access to an array elements in the + bus message m. The "read pointer" in the message must be right before an array of type + type. As a special case, type may be + NUL, in which case any trivial type is acceptable. A pointer to the array data is returned + in the parameter ptr and the size of array data (in bytes) is returned in the + parameter size. If the returned size parameter is 0, a + valid non-null pointer will be returned as ptr, but it may not be + dereferenced. The data is aligned as 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. + + 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. + + + + Return Value + + + On success and when an array was read, sd_bus_message_read_array() returns an + integer greater than zero. If invoked while inside a container element (such as an array, e.g. when + operating on an array of arrays) and the final element of the outer container has been read already and + the read pointer is thus behind the last element of the outer container this call returns 0 (and the + returned pointer will be NULL and the size will be 0). On failure, it returns a + negative errno-style error code. + + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + Specified type is invalid or not a trivial type (see above), or the message + parameter or one of the output parameters are NULL. + + + + -EOPNOTSUPP + + The byte order in the message is different than native byte + order. + + + + -EPERM + + The message is not sealed. + + + + -EBADMSG + + The message cannot be parsed. + + + + + + + + History + sd_bus_message_read_array() was added in version 240. + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_read3, + sd_bus_message_read_strv3 + + + + -- cgit v1.2.3