sd_bus_message_skip(3) — Linux manual page

SD_BUS_MESSAGE_SKIP(3)     sd_bus_message_skip    SD_BUS_MESSAGE_SKIP(3)

NAME         top

       sd_bus_message_skip - Skip elements in a bus message

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_message_skip(sd_bus_message *m, const char* types);

DESCRIPTION         top

       sd_bus_message_skip() is somewhat similar to
       sd_bus_message_read(3), but instead of reading the contents of
       the message, it only moves the "read pointer". Subsequent read
       operations will read the elements that are after the elements
       that were skipped.

       The types argument has the same meaning as in
       sd_bus_message_read(). It may also be NULL, to skip a single
       element of any type.

RETURN VALUE         top

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

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           The m parameter is NULL.

       -EBADMSG
           The message cannot be parsed.

       -EPERM
           The message is not sealed.

       -ENXIO
           The message end has been reached and the requested elements
           cannot be read.

       -ENOMEM
           Memory allocation failed.

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_skip() was added in version 240.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_message_read(3),
       sd_bus_message_read_basic(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
       [email protected]

systemd 257~devel                                 SD_BUS_MESSAGE_SKIP(3)

Pages that refer to this page: sd-bus(3),  sd_bus_message_open_container(3),  sd_bus_message_read(3),  sd_bus_message_read_basic(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.