diff --git a/man/rules/meson.build b/man/rules/meson.build index f11382ab83..2c1edae27b 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -319,6 +319,7 @@ manpages = [ ['sd_bus_message_read', '3', ['sd_bus_message_readv'], ''], ['sd_bus_message_read_array', '3', [], ''], ['sd_bus_message_read_basic', '3', [], ''], + ['sd_bus_message_read_strv', '3', [], ''], ['sd_bus_message_rewind', '3', [], ''], ['sd_bus_message_seal', '3', [], ''], ['sd_bus_message_sensitive', '3', [], ''], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index e8792cd6c9..e8bca273c7 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -110,6 +110,7 @@ sd_bus_message_read3, sd_bus_message_read_array3, sd_bus_message_read_basic3, +sd_bus_message_read_strv3, sd_bus_message_rewind3, sd_bus_message_seal3, sd_bus_message_set_destination3, diff --git a/man/sd_bus_list_names.xml b/man/sd_bus_list_names.xml index d1aba6ef52..ad7ecd00e3 100644 --- a/man/sd_bus_list_names.xml +++ b/man/sd_bus_list_names.xml @@ -45,10 +45,9 @@ acquired is not NULL, the function calls org.freedesktop.DBus.ListActivableNames to retrieve the list of all names on the bus that can be - activated. Note that ownership of any string arrays returned by sd_bus_list_names() - is transferred to the caller and hence, the caller is responsible for freeing any results stored by - sd_bus_list_names() in acquired and - activatable. + activated. Note that ownership of the arrays returned by sd_bus_list_names() in + acquired and activatable is transferred to the caller and + hence, the caller is responsible for freeing these arrays and their contents. diff --git a/man/sd_bus_message_read_array.xml b/man/sd_bus_message_read_array.xml index 26e8ebae60..7f9f9703b6 100644 --- a/man/sd_bus_message_read_array.xml +++ b/man/sd_bus_message_read_array.xml @@ -105,7 +105,8 @@ systemd1, sd-bus3, - sd_bus_message_read3 + sd_bus_message_read3, + sd_bus_message_read_strv3 diff --git a/man/sd_bus_message_read_strv.xml b/man/sd_bus_message_read_strv.xml new file mode 100644 index 0000000000..a86bbe45d8 --- /dev/null +++ b/man/sd_bus_message_read_strv.xml @@ -0,0 +1,90 @@ + + + + + + + + sd_bus_message_read_strv + systemd + + + + sd_bus_message_read_strv + 3 + + + + sd_bus_message_read_strv + + Access an array of strings in a message + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_message_read_strv + sd_bus_message *m + char ***l + + + + + + Description + + sd_bus_message_read_strv() gives access to an array of strings in message + m. The "read pointer" in the message must be right before an array of strings. On + success, a pointer to the NULL-terminated array of strings is returned in the output + parameter l. Note that ownership of this array is transferred to the caller. + Hence, the caller is responsible for freeing this array and its contents. + + + + Return Value + + On success, sd_bus_message_read_strv() returns a non-negative integer. On + failure, it returns a negative errno-style error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + m or l are NULL. + + + + + -EPERM + + The message is not sealed. + + + + -EBADMSG + + The message cannot be parsed. + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_read3 + + + +