sd_bus_message_rewind(3) — Linux manual page

SD_BUS_MESSAGE_REWIND(3)  sd_bus_message_rewind SD_BUS_MESSAGE_REWIND(3)

NAME         top

       sd_bus_message_rewind - Return to beginning of message or current
       container

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_rewind(sd_bus_message *m, int complete);

DESCRIPTION         top

       sd_bus_message_rewind() moves the "read pointer" in the message m
       to either the beginning of the message (if complete is true) or
       to the beginning of the currently open container. If no container
       is open, complete has no effect.

RETURN VALUE         top

       On success, this function returns 0 or a positive integer. The
       value is zero if the current container or whole message in case
       no container is open is empty, and positive otherwise. On
       failure, it returns a negative errno-style error code.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           The m parameter is NULL.

       -EPERM
           The message m has not been sealed.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been
       started.

HISTORY         top

       sd_bus_message_rewind() was added in version 240.

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 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  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 257~devel                               SD_BUS_MESSAGE_REWIND(3)

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

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.