Debian Codegraph @

upstream/debian-unstable/man3/sd_bus_message_get_signature.3

raw
1 '\" t
2 .TH "SD_BUS_MESSAGE_GET_SIGNATURE" "3" "" "systemd 261~rc3" "sd_bus_message_get_signature"
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_get_signature, sd_bus_message_is_empty, sd_bus_message_has_signature \- Query bus message signature
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-bus\&.h>
29 .fi
30 .ft
31 .HP \w'const\ char*\ sd_bus_message_get_signature('u
32 .BI "const char* sd_bus_message_get_signature(sd_bus_message\ *" "message" ", int\ " "complete" ");"
33 .HP \w'int\ sd_bus_message_is_empty('u
34 .BI "int sd_bus_message_is_empty(sd_bus_message\ *" "message" ");"
35 .HP \w'int\ sd_bus_message_has_signature('u
36 .BI "int sd_bus_message_has_signature(sd_bus_message\ *" "message" ", const\ char\ *" "signature" ");"
37 .SH "DESCRIPTION"
38 .PP
39 \fBsd_bus_message_get_signature()\fR
40 returns the signature of message
41 \fImessage\fR\&. If
42 \fIcomplete\fR
43 is true, the signature of the whole message is returned, and just the signature of the currently open container otherwise\&.
44 .PP
45 \fBsd_bus_message_is_empty()\fR
46 returns true if the message is empty, i\&.e\&. when its signature is empty\&.
47 .PP
48 \fBsd_bus_message_has_signature()\fR
49 returns true if the signature of the message
50 \fImessage\fR
51 matches given
52 \fIsignature\fR\&. Parameter
53 \fIsignature\fR
54 may be
55 \fBNULL\fR, this is treated the same as an empty string, which is equivalent to calling
56 \fBsd_bus_message_is_empty()\fR\&.
57 .SH "RETURN VALUE"
58 .PP
59 On success,
60 \fBsd_bus_message_get_signature()\fR
61 returns the signature, and
62 \fBNULL\fR
63 on error\&.
64 .PP
65 The other functions return 0 or a positive integer on success\&. On failure, they return a negative errno\-style error code\&.
66 .SS "Errors"
67 .PP
68 Returned errors may indicate the following problems:
69 .PP
70 \fB\-EINVAL\fR
71 .RS 4
72 The
73 \fImessage\fR
74 parameter is
75 \fBNULL\fR\&.
76 .RE
77 .PP
78 \fBNULL\fR
79 .RS 4
80 The
81 \fImessage\fR
82 parameter is
83 \fBNULL\fR\&.
84 .RE
85 .SH "NOTES"
86 .PP
87 Functions described here are available as a shared library, which can be compiled against and linked to with the
88 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
89 file\&.
90 .PP
91 The code described here uses
92 \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
93 \fBsetenv\fR(3)
94 from a parallel thread\&. It is recommended to only do calls to
95 \fBsetenv()\fR
96 from an early phase of the program when no other threads have been started\&.
97 .SH "HISTORY"
98 .PP
99 \fBsd_bus_message_get_signature()\fR,
100 \fBsd_bus_message_is_empty()\fR, and
101 \fBsd_bus_message_has_signature()\fR
102 were added in version 240\&.
103 .SH "SEE ALSO"
104 .PP
105 \fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_new\fR(3)