sd_bus_message_skip(3) — Chainguard OS Manuals

SD_BUS_MESSAGE_SKIP(3)

sd_bus_message_skip

SD_BUS_MESSAGE_SKIP(3)

.SH "NAME" sd_bus_message_skip - Skip elements in a bus message

.SH "SYNOPSIS"

#include <systemd/sd-bus.h>

.HP 576u int sd_bus_message_skip(sd_bus_message *m, const char* types);

.SH "DESCRIPTION"

.PP 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.

.PP 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.

.SH "RETURN VALUE"

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

.SS "Errors"

.PP Returned errors may indicate the following problems:

.PP -EINVAL

The m parameter is NULL.

.RE

.PP -EBADMSG

The message cannot be parsed.

.RE

.PP -EPERM

The message is not sealed.

.RE

.PP -ENXIO

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

.RE

.PP -ENOMEM

Memory allocation failed.

.RE

.SH "NOTES"

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

.PP All functions listed here are thread-agnostic and only a single thread may operate on a given object at any given time. Different threads may access the same object at different times. Multiple independent objects may be used from different threads in parallel.

.PP 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.

.SH "HISTORY"

.PP sd_bus_message_skip() was added in version 240.

systemd 262.2