2018-08-11 10:35:26 +03:00
<?xml version='1.0'?>
2019-03-14 16:40:58 +03:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2018-08-11 10:35:26 +03:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX - License - Identifier: LGPL - 2.1+ -->
<refentry id= "sd_bus_message_skip" xmlns:xi= "http://www.w3.org/2001/XInclude" >
<refentryinfo >
<title > sd_bus_message_skip</title>
<productname > systemd</productname>
</refentryinfo>
<refmeta >
<refentrytitle > sd_bus_message_skip</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > sd_bus_message_skip</refname>
<refpurpose > Skip elements in a bus message</refpurpose>
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < systemd/sd-bus.h> </funcsynopsisinfo>
<funcprototype >
<funcdef > int <function > sd_bus_message_skip</function> </funcdef>
<paramdef > sd_bus_message *<parameter > m</parameter> </paramdef>
<paramdef > const char* <parameter > types</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <function > sd_bus_message_skip()</function> is somewhat similar to
<citerefentry > <refentrytitle > sd_bus_message_read</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
but instead of reading the contents of the message, it only moves the "read pointer". Subsequent
read operations will read the elements that are after the elements that were skipped.</para>
<para > The <parameter > types</parameter> argument has the same meaning as in
<function > sd_bus_message_read()</function> . It may also be <constant > NULL</constant> , to skip a
single element of any type.</para>
</refsect1>
<refsect1 >
<title > Return Value</title>
<para > On success, <function > sd_bus_message_skip()</function> returns 0 or a positive integer. On
failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1 >
<title > Errors</title>
<para > Returned errors may indicate the following problems:</para>
<variablelist >
<varlistentry >
<term > <constant > -EINVAL</constant> </term>
<listitem > <para > The <parameter > m</parameter> parameter is
<constant > NULL</constant> .</para> </listitem>
</varlistentry>
<varlistentry >
<term > <constant > -EBADMSG</constant> </term>
<listitem > <para > The message cannot be parsed.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <constant > -EPERM</constant> </term>
<listitem > <para > The message is not sealed.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <constant > -ENXIO</constant> </term>
<listitem > <para > The message end has been reached and the requested elements cannot be read.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <constant > -ENOMEM</constant> </term>
<listitem > <para > Memory allocation failed.</para> </listitem>
</varlistentry>
</variablelist>
</refsect1>
<xi:include href= "libsystemd-pkgconfig.xml" />
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd-bus</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd_bus_message_read</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd_bus_message_read_basic</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
</para>
</refsect1>
</refentry>