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

154 lines
3.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SD_BUS_MESSAGE_SKIP</TITLE>
</HEAD><BODY>
<H1>SD_BUS_MESSAGE_SKIP</H1>
Section: sd_bus_message_skip (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_skip - Skip elements in a bus 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_skip(sd_bus_message&nbsp;*</B><I>m</I><B>, const&nbsp;char*&nbsp;</B><I>types</I><B>);</B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>sd_bus_message_skip()</B>
<DD>is somewhat similar to
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_message_read">sd_bus_message_read</A></B>(3), but instead of reading the contents of the message, it only moves the &quot;read pointer&quot;. Subsequent read operations will read the elements that are after the elements that were skipped.
<P>
The
<I>types</I>
argument has the same meaning as in
<B>sd_bus_message_read()</B>. It may also be
<B>NULL</B>, to skip a single element of any type.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
<P>
On success,
<B>sd_bus_message_skip()</B>
returns 0 or a positive integer. On failure, it returns a negative errno-style error code.
<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>
The
<I>m</I>
parameter is
<B>NULL</B>.
</DL>
<P>
<B>-EBADMSG</B>
<DL COMPACT><DT id="3"><DD>
The message cannot be parsed.
</DL>
<P>
<B>-EPERM</B>
<DL COMPACT><DT id="4"><DD>
The message is not sealed.
</DL>
<P>
<B>-ENXIO</B>
<DL COMPACT><DT id="5"><DD>
The message end has been reached and the requested elements cannot be read.
</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_read">sd_bus_message_read</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+sd_bus_message_read_basic">sd_bus_message_read_basic</A></B>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
<DT id="8"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="9"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="10"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DL>
<DT id="11"><A HREF="#lbAF">Errors</A><DD>
</DL>
<DT id="12"><A HREF="#lbAG">NOTES</A><DD>
<DT id="13"><A HREF="#lbAH">SEE ALSO</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:55 GMT, March 31, 2021
</BODY>
</HTML>