2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
6 <refentry id=
"sd_bus_message_seal"
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>sd_bus_message_seal
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>sd_bus_message_seal
</refentrytitle>
16 <manvolnum>3</manvolnum>
20 <refname>sd_bus_message_seal
</refname>
22 <refpurpose>Prepare a D-Bus message for transmission
</refpurpose>
27 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
30 <funcdef>int
<function>sd_bus_message_seal
</function></funcdef>
31 <paramdef>sd_bus_message *
<parameter>m
</parameter></paramdef>
32 <paramdef>uint64_t
<parameter>cookie
</parameter></paramdef>
33 <paramdef>uint64_t
<parameter>timeout_usec
</parameter></paramdef>
39 <title>Description
</title>
41 <para><function>sd_bus_message_seal()
</function> finishes the message
<parameter>m
</parameter>
42 and prepares it for transmission using
43 <citerefentry><refentrytitle>sd_bus_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
44 <parameter>cookie
</parameter> specifies the identifier used to match the message reply to its
45 corresponding request.
<parameter>timeout_usec
</parameter> specifies the maximum time in
46 microseconds to wait for a reply to arrive.
</para>
48 <para>Note that in most scenarios, it's not necessary to call this function directly.
49 <citerefentry><refentrytitle>sd_bus_call
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
50 <citerefentry><refentrytitle>sd_bus_call_async
</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
51 <citerefentry><refentrytitle>sd_bus_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
52 will seal any given messages if they have not been sealed yet.
</para>
56 <title>Return Value
</title>
58 <para>On success, this function returns a non-negative integer. On failure, it returns a
59 negative errno-style error code.
</para>
64 <para>Returned errors may indicate the following problems:
</para>
68 <term><constant>-EINVAL
</constant></term>
70 <listitem><para>The
<parameter>m
</parameter> parameter is
<constant>NULL
</constant>.
75 <term><constant>-EBADMSG
</constant></term>
77 <listitem><para>The D-Bus message
<parameter>m
</parameter> has open containers.
82 <term><constant>-ENOMSG
</constant></term>
84 <listitem><para>The D-Bus message
<parameter>m
</parameter> is a reply but its type
85 signature does not match the return type signature of its corresponding member in the
86 object vtable.
</para></listitem>
92 <xi:include href=
"libsystemd-pkgconfig.xml" />
95 <title>See Also
</title>
98 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
99 <citerefentry><refentrytitle>sd-bus
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
100 <citerefentry><refentrytitle>sd_bus_call
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
101 <citerefentry><refentrytitle>sd_bus_call_async
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
102 <citerefentry><refentrytitle>sd_bus_send
</refentrytitle><manvolnum>3</manvolnum></citerefentry>