systemd/man/sd_bus_message_append_strv.3
2015-02-17 11:22:16 +01:00

104 lines
2.9 KiB
Groff

'\" t
.TH "SD_BUS_MESSAGE_APPEND_STRV" "3" "" "systemd 219" "sd_bus_message_append_strv"
.\" -----------------------------------------------------------------
.\" * 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_append_strv \- Attach an array of strings to a message
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'int\ sd_bus_message_append_strv('u
.BI "int sd_bus_message_append_strv(sd_bus_message\ *" "m" ", char\ **" "l" ");"
.SH "DESCRIPTION"
.PP
The
\fBsd_bus_message_append\fR
function can be used to append an array of strings to message
\fIm\fR\&. The parameter
\fIl\fR
shall point to a
\fBNULL\fR\-terminated array of pointers to
\fBNUL\fR\-terminated strings\&. Each string must satisfy the same constraints as described for the
"s"
type in
\fBsd_bus_message_append_basic\fR(3)\&.
.PP
The memory pointed at by
\fIp\fR
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
\fIl\fR
parameter is to be treated as
\fBconst char\ \&*const\ \&*\fR, and the contents will not be modified\&.
.SH "RETURN VALUE"
.PP
On success, this call returns 0 or a positive integer\&. On failure, a negative errno\-style error code is returned\&.
.SH "ERRORS"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
Specified parameter is invalid\&.
.RE
.PP
\fB\-EPERM\fR
.RS 4
Message has been sealed\&.
.RE
.PP
\fB\-ESTALE\fR
.RS 4
Message is in invalid state\&.
.RE
.PP
\fB\-ENXIO\fR
.RS 4
Message cannot be appended to\&.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
Memory allocation failed\&.
.RE
.SH "NOTES"
.PP
The
\fBsd_bus_append_append_strv()\fR
function described here is available as a shared library, which can be compiled and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.SH "SEE ALSO"
.PP
\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
.SH "NOTES"
.IP " 1." 4
The D-Bus specification
.RS 4
\%http://dbus.freedesktop.org/doc/dbus-specification.html
.RE