diff --git a/man/rules/meson.build b/man/rules/meson.build index 2edf2c21c2..96b56569e3 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -259,6 +259,7 @@ manpages = [ 'sd_bus_message_get_expect_reply', 'sd_bus_message_set_auto_start'], ''], + ['sd_bus_message_skip', '3', [], ''], ['sd_bus_message_verify_type', '3', [], ''], ['sd_bus_negotiate_fds', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 3daafc4495..7c0b3c1e6e 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -70,6 +70,7 @@ sd_bus_message_rewind3, sd_bus_message_set_destination3, sd_bus_message_set_expect_reply3, +sd_bus_message_skip3, sd_bus_message_verify_type3, sd_bus_negotiate_fds3, sd_bus_new3, diff --git a/man/sd_bus_message_read.xml b/man/sd_bus_message_read.xml index c86f55fb54..2815c01986 100644 --- a/man/sd_bus_message_read.xml +++ b/man/sd_bus_message_read.xml @@ -224,6 +224,7 @@ sd_bus_message_read(m, "a{is}", 3, &i, &s, &j, &t, &k, & systemd1, sd-bus3, sd_bus_message_read_basic3, + sd_bus_message_skip3, sd_bus_message_append3 diff --git a/man/sd_bus_message_read_basic.xml b/man/sd_bus_message_read_basic.xml index e39cfd5bd6..774d3fcf87 100644 --- a/man/sd_bus_message_read_basic.xml +++ b/man/sd_bus_message_read_basic.xml @@ -227,6 +227,7 @@ systemd1, sd-bus3, sd_bus_message_append_basic3, + sd_bus_message_skip3, sd_bus_message_read3 diff --git a/man/sd_bus_message_skip.xml b/man/sd_bus_message_skip.xml new file mode 100644 index 0000000000..384a791494 --- /dev/null +++ b/man/sd_bus_message_skip.xml @@ -0,0 +1,108 @@ + + + + + + + sd_bus_message_skip + systemd + + + + sd_bus_message_skip + 3 + + + + sd_bus_message_skip + + Skip elements in a bus message + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_message_skip + sd_bus_message *m + const char* types + + + + + + Description + + sd_bus_message_skip() is somewhat similar to + sd_bus_message_read3, + 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 + + 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. + + + + + + + + See Also + + + systemd1, + sd-bus3, + sd_bus_message_read3, + sd_bus_message_read_basic3 + + + +