sd_bus_message_read_strv(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | COLOPHON

SD_BUS_MESSAGE_READ_STRV(3)bus_message_read_strvBUS_MESSAGE_READ_STRV(3)

NAME         top

       sd_bus_message_read_strv - Access an array of strings in a
       message

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_read_strv(sd_bus_message *m, char ***l);

DESCRIPTION         top

       sd_bus_message_read_strv() gives access to an array of
       string-like items in message m. The "read pointer" in the message
       must be right before an array of strings (D-Bus type "as"),
       object paths (D-Bus type "ao"), or signatures (D-Bus type "ag").
       On success, a pointer to a 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         top

       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.

       -ENXIO
           The message "read pointer" is not right before an array of
           the appropriate type.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_read(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2021-06-20.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2021-06-19.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 249                                  SD_BUS_MESSAGE_READ_STRV(3)

Pages that refer to this page: sd-bus(3)sd_bus_message_read_array(3)systemd.directives(7)systemd.index(7)