diff options
Diffstat (limited to 'man/sd_bus_message_at_end.xml')
-rw-r--r-- | man/sd_bus_message_at_end.xml | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man/sd_bus_message_at_end.xml b/man/sd_bus_message_at_end.xml new file mode 100644 index 0000000..9cff48a --- /dev/null +++ b/man/sd_bus_message_at_end.xml @@ -0,0 +1,86 @@ +<?xml version='1.0'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="sd_bus_message_at_end" xmlns:xi="http://www.w3.org/2001/XInclude"> + <refentryinfo> + <title>sd_bus_message_at_end</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>sd_bus_message_at_end</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd_bus_message_at_end</refname> + + <refpurpose>Check if a message has been fully read</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>int <function>sd_bus_message_at_end</function></funcdef> + <paramdef>sd_bus_message *<parameter>m</parameter></paramdef> + <paramdef>int <parameter>complete</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><function>sd_bus_message_at_end()</function> returns whether all data from the currently opened + container in <parameter>m</parameter> or all data from all containers in <parameter>m</parameter> has + been read. If <parameter>complete</parameter> is zero, this function returns whether all data from the + currently opened container has been read. If <parameter>complete</parameter> is non-zero, this function + returns whether all data from all containers in <parameter>m</parameter> has been read.</para> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para>If all data from all containers or the current container (depending on the value of + <parameter>complete</parameter>) has been read, <function>sd_bus_message_at_end()</function> returns a + positive integer. If there is still data left to be read, it returns zero. On failure, it returns a + negative errno-style error code.</para> + + <refsect2> + <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>-EPERM</constant></term> + + <listitem><para>The message is not sealed.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + </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> + </para> + </refsect1> +</refentry> |