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

SD_BUS_MESSAGE_READ_BASIC(3)_bus_message_read_basicBUS_MESSAGE_READ_BASIC(3)

NAME         top

       sd_bus_message_read_basic - Read a basic type from a message

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_read_basic(sd_bus_message *m, char type, void *p);

DESCRIPTION         top

       sd_bus_message_read_basic() reads a basic type from a message and
       advances the read position in the message. The set of basic types and
       their ascii codes passed in type are described in the D-Bus
       Specification[1].

       If p is not NULL, it should contain a pointer to an appropriate
       object. For example, if type is 'y', the object passed in p should
       have type uint8_t *. If type is 's', the object passed in p should
       have type const char **. Note that, if the basic type is a pointer
       (e.g., const char * in the case of a string), the pointer is only
       borrowed and the contents must be copied if they are to be used after
       the end of the messages lifetime. Similarly, during the lifetime of
       such a pointer, the message must not be modified.

       If there is no object of the specified type at the current position
       in the message, an error is returned.

RETURN VALUE         top

       On success, sd_bus_message_read_basic() returns 0 or a positive
       integer. On failure, it returns a negative errno-style error code.

SEE ALSO         top

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

NOTES         top

        1. D-Bus Specification
           https://dbus.freedesktop.org/doc/dbus-specification.html

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 2017-09-15.  If you dis‐
       cover 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 234                                     SD_BUS_MESSAGE_READ_BASIC(3)

Pages that refer to this page: systemd.directives(7)systemd.index(7)