Debian Codegraph @

upstream/debian-unstable/man3/sd_bus_message_append_strv.3

raw
1 '\" t
2 .TH "SD_BUS_MESSAGE_APPEND_STRV" "3" "" "systemd 261~rc3" "sd_bus_message_append_strv"
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_append_strv \- Attach an array of strings to a 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_append_strv('u
32 .BI "int sd_bus_message_append_strv(sd_bus_message\ *" "m" ", char\ **" "l" ");"
33 .SH "DESCRIPTION"
34 .PP
35 The
36 \fBsd_bus_message_append()\fR
37 function can be used to append an array of strings to message
38 \fIm\fR\&. The parameter
39 \fIl\fR
40 shall point to a
41 \fBNULL\fR\-terminated array of pointers to
42 \fBNUL\fR\-terminated strings\&. Each string must satisfy the same constraints as described for the
43 "s"
44 type in
45 \fBsd_bus_message_append_basic\fR(3)\&.
46 .PP
47 The memory pointed at by
48 \fIp\fR
49 and the contents of the strings themselves are copied into the memory area containing the message and may be changed after this call\&. Note that the signature of
50 \fIl\fR
51 parameter is to be treated as
52 \fBconst char\ \&*const\ \&*\fR, and the contents will not be modified\&.
53 .SH "RETURN VALUE"
54 .PP
55 On success, this call returns 0 or a positive integer\&. On failure, a negative errno\-style error code is returned\&.
56 .SS "Errors"
57 .PP
58 Returned errors may indicate the following problems:
59 .PP
60 \fB\-EINVAL\fR
61 .RS 4
62 Specified parameter is invalid\&.
63 .RE
64 .PP
65 \fB\-EPERM\fR
66 .RS 4
67 Message has been sealed\&.
68 .RE
69 .PP
70 \fB\-ESTALE\fR
71 .RS 4
72 Message is in invalid state\&.
73 .RE
74 .PP
75 \fB\-ENXIO\fR
76 .RS 4
77 Message cannot be appended to\&.
78 .RE
79 .PP
80 \fB\-ENOMEM\fR
81 .RS 4
82 Memory allocation failed\&.
83 .RE
84 .SH "NOTES"
85 .PP
86 Functions described here are available as a shared library, which can be compiled against and linked to with the
87 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
88 file\&.
89 .PP
90 The code described here uses
91 \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
92 \fBsetenv\fR(3)
93 from a parallel thread\&. It is recommended to only do calls to
94 \fBsetenv()\fR
95 from an early phase of the program when no other threads have been started\&.
96 .SH "SEE ALSO"
97 .PP
98 \fBsystemd\fR(1), \fBsd-bus\fR(3), \fBsd_bus_message_append\fR(3), \fBsd_bus_message_append_array\fR(3), \m[blue]\fBThe D\-Bus specification\fR\m[]\&\s-2\u[1]\d\s+2
99 .SH "NOTES"
100 .IP " 1." 4
101 The D-Bus specification
102 .RS 4
103 \%https://dbus.freedesktop.org/doc/dbus-specification.html
104 .RE