Debian Codegraph @

upstream/debian-unstable/man3/sd_bus_message_skip.3

raw
1 '\" t
2 .TH "SD_BUS_MESSAGE_SKIP" "3" "" "systemd 261~rc3" "sd_bus_message_skip"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 sd_bus_message_skip \- Skip elements in a bus message
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-bus\&.h>
29 .fi
30 .ft
31 .HP \w'int\ sd_bus_message_skip('u
32 .BI "int sd_bus_message_skip(sd_bus_message\ *" "m" ", const\ char*\ " "types" ");"
33 .SH "DESCRIPTION"
34 .PP
35 \fBsd_bus_message_skip()\fR
36 is somewhat similar to
37 \fBsd_bus_message_read\fR(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\&.
38 .PP
39 The
40 \fItypes\fR
41 argument has the same meaning as in
42 \fBsd_bus_message_read()\fR\&. It may also be
43 \fBNULL\fR, to skip a single element of any type\&.
44 .SH "RETURN VALUE"
45 .PP
46 On success,
47 \fBsd_bus_message_skip()\fR
48 returns 0 or a positive integer\&. On failure, it returns a negative errno\-style error code\&.
49 .SS "Errors"
50 .PP
51 Returned errors may indicate the following problems:
52 .PP
53 \fB\-EINVAL\fR
54 .RS 4
55 The
56 \fIm\fR
57 parameter is
58 \fBNULL\fR\&.
59 .RE
60 .PP
61 \fB\-EBADMSG\fR
62 .RS 4
63 The message cannot be parsed\&.
64 .RE
65 .PP
66 \fB\-EPERM\fR
67 .RS 4
68 The message is not sealed\&.
69 .RE
70 .PP
71 \fB\-ENXIO\fR
72 .RS 4
73 The message end has been reached and the requested elements cannot be read\&.
74 .RE
75 .PP
76 \fB\-ENOMEM\fR
77 .RS 4
78 Memory allocation failed\&.
79 .RE
80 .SH "NOTES"
81 .PP
82 Functions described here are available as a shared library, which can be compiled against and linked to with the
83 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
84 file\&.
85 .PP
86 The code described here uses
87 \fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
88 \fBsetenv\fR(3)
89 from a parallel thread\&. It is recommended to only do calls to
90 \fBsetenv()\fR
91 from an early phase of the program when no other threads have been started\&.
92 .SH "HISTORY"
93 .PP
94 \fBsd_bus_message_skip()\fR
95 was added in version 240\&.
96 .SH "SEE ALSO"
97 .PP
98 \fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_read\fR(3), \fBsd_bus_message_read_basic\fR(3)