blob: d4bdc194139a377f36c4451a8473e0d7dd5e8982 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
'\" t
.TH "SD_BUS_MESSAGE_COPY" "3" "" "systemd 255" "sd_bus_message_copy"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_bus_message_copy \- Copy the contents of one message to another
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'int\ sd_bus_message_copy('u
.BI "int sd_bus_message_copy(sd_bus_message\ *" "m" ", sd_bus_message\ *" "source" ", int\ " "all" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_message_copy()\fR
copies the contents from message
\fIsource\fR
to
\fIm\fR\&. If
\fIall\fR
is false, a single complete type is copied (basic or container)\&. If
\fIall\fR
is true, the contents are copied until the end of the currently open container or the end of
\fIsource\fR\&.
.SH "RETURN VALUE"
.PP
On success, this call returns true if anything was copied, and false if there was nothing to copy\&. On failure, it returns a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
\fIsource\fR
or
\fIm\fR
are
\fBNULL\fR\&.
.RE
.PP
\fB\-EPERM\fR
.RS 4
Message
\fIm\fR
has been sealed or
\fIsource\fR
has
\fInot\fR
been sealed\&.
.RE
.PP
\fB\-ESTALE\fR
.RS 4
Destination message is in invalid state\&.
.RE
.PP
\fB\-ENXIO\fR
.RS 4
Destination message cannot be appended to\&.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
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
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\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
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),
\fBsd_bus_message_append\fR(3)
|
