man-pages/man3/sd_bus_message_append_strv.3.html
2021-03-31 01:06:50 +01:00

171 lines
3.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SD_BUS_MESSAGE_APPEND_STRV</TITLE>
</HEAD><BODY>
<H1>SD_BUS_MESSAGE_APPEND_STRV</H1>
Section: sd_bus_message_append_strv (3)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
sd_bus_message_append_strv - Attach an array of strings to a message
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>
</B><PRE>
#include &lt;<A HREF="file:///usr/include/systemd/sd-bus.h">systemd/sd-bus.h</A>&gt;
</PRE>
<DL COMPACT>
<DT id="1">
<B>int sd_bus_message_append_strv(sd_bus_message&nbsp;*</B><I>m</I><B>, char&nbsp;**</B><I>l</I><B>);</B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>The
<B>sd_bus_message_append</B>
function can be used to append an array of strings to message
<I>m</I>. The parameter
<I>l</I>
shall point to a
<B>NULL</B>-terminated array of pointers to
<B>NUL</B>-terminated strings. Each string must satisfy the same constraints as described for the
&quot;s&quot;
type in
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_message_append_basic">sd_bus_message_append_basic</A></B>(3).
<P>
The memory pointed at by
<I>p</I>
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
<I>l</I>
parameter is to be treated as
<B>const char&nbsp;*const&nbsp;*</B>, and the contents will not be modified.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<P>
On success, this call returns 0 or a positive integer. On failure, a negative errno-style error code is returned.
<A NAME="lbAF">&nbsp;</A>
<H3>Errors</H3>
<P>
Returned errors may indicate the following problems:
<P>
<B>-EINVAL</B>
<DL COMPACT><DT id="2"><DD>
Specified parameter is invalid.
</DL>
<P>
<B>-EPERM</B>
<DL COMPACT><DT id="3"><DD>
Message has been sealed.
</DL>
<P>
<B>-ESTALE</B>
<DL COMPACT><DT id="4"><DD>
Message is in invalid state.
</DL>
<P>
<B>-ENXIO</B>
<DL COMPACT><DT id="5"><DD>
Message cannot be appended to.
</DL>
<P>
<B>-ENOMEM</B>
<DL COMPACT><DT id="6"><DD>
Memory allocation failed.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>NOTES</H2>
<P>
These APIs are implemented as a shared library, which can be compiled and linked to with the
<B>libsystemd</B>&nbsp;<B><A HREF="/cgi-bin/man/man2html?1+pkg-config">pkg-config</A></B>(1)
file.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?3+sd-bus">sd-bus</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_message_append">sd_bus_message_append</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_message_append_array">sd_bus_message_append_array</A></B>(3),
m[blue]<B>The D-Bus specification</B>m[]<FONT SIZE="-2">[1]</FONT>
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
<DL COMPACT>
<DT id="7"> 1.<DD>
The D-Bus specification
<DL COMPACT><DT id="8"><DD>
<A HREF="http://dbus.freedesktop.org/doc/dbus-specification.html">http://dbus.freedesktop.org/doc/dbus-specification.html</A>
</DL>
<P>
</DL>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DL>
<DT id="13"><A HREF="#lbAF">Errors</A><DD>
</DL>
<DT id="14"><A HREF="#lbAG">NOTES</A><DD>
<DT id="15"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="16"><A HREF="#lbAI">NOTES</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:54 GMT, March 31, 2021
</BODY>
</HTML>