2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"sd_bus_reply_method_error"
10 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
13 <title>sd_bus_reply_method_error
</title>
14 <productname>systemd
</productname>
18 <refentrytitle>sd_bus_reply_method_error
</refentrytitle>
19 <manvolnum>3</manvolnum>
23 <refname>sd_bus_reply_method_error
</refname>
24 <refname>sd_bus_reply_method_errorf
</refname>
25 <refname>sd_bus_reply_method_errno
</refname>
26 <refname>sd_bus_reply_method_errnof
</refname>
28 <refpurpose>Reply with an error to a method call
</refpurpose>
33 <funcsynopsisinfo>#include
<systemd/sd-bus.h
></funcsynopsisinfo>
36 <funcdef>int sd_bus_reply_method_error
</funcdef>
37 <paramdef>sd_bus_message *
<parameter>call
</parameter></paramdef>
38 <paramdef>const sd_bus_error *
<parameter>e
</parameter></paramdef>
42 <funcdef>int sd_bus_reply_method_errorf
</funcdef>
43 <paramdef>sd_bus_message *
<parameter>call
</parameter></paramdef>
44 <paramdef>const char *
<parameter>name
</parameter></paramdef>
45 <paramdef>const char *
<parameter>format
</parameter></paramdef>
46 <paramdef>…
</paramdef>
50 <funcdef>int sd_bus_reply_method_errno
</funcdef>
51 <paramdef>sd_bus_message *
<parameter>call
</parameter></paramdef>
52 <paramdef>int
<parameter>error
</parameter></paramdef>
53 <paramdef>const sd_bus_error *
<parameter>p
</parameter></paramdef>
57 <funcdef>int sd_bus_reply_method_errnof
</funcdef>
58 <paramdef>sd_bus_message *
<parameter>call
</parameter></paramdef>
59 <paramdef>int
<parameter>error
</parameter></paramdef>
60 <paramdef>const char *
<parameter>format
</parameter></paramdef>
61 <paramdef>…
</paramdef>
67 <title>Description
</title>
69 <para>The
<function>sd_bus_reply_method_error()
</function> function sends an
70 error reply to the
<parameter>call
</parameter> message. The error structure
71 <parameter>e
</parameter> specifies the error to send, and is used as described in
72 <citerefentry><refentrytitle>sd_bus_message_new_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
73 If no reply is expected to
<parameter>call
</parameter>, this function returns
74 success without sending reply.
</para>
76 <para>The
<function>sd_bus_reply_method_errorf()
</function> is to
77 <function>sd_bus_reply_method_error()
</function> what
78 <function>sd_bus_message_new_method_errorf()
</function> is to
79 <function>sd_bus_message_new_method_error()
</function>.
</para>
81 <para>The
<function>sd_bus_reply_method_errno()
</function> is to
82 <function>sd_bus_reply_method_error()
</function> what
83 <function>sd_bus_message_new_method_errno()
</function> is to
84 <function>sd_bus_message_new_method_error()
</function>.
</para>
86 <para>The
<function>sd_bus_reply_method_errnof()
</function> is to
87 <function>sd_bus_reply_method_error()
</function> what
88 <function>sd_bus_message_new_method_errnof()
</function> is to
89 <function>sd_bus_message_new_method_error()
</function>.
</para>
93 <title>Return Value
</title>
95 <para>These functions return
0 if the error reply was successfully sent or if
96 none was expected, and a negative errno-style error code otherwise.
</para>
99 <refsect1 id='errors'
>
100 <title>Errors
</title>
102 <para>Returned errors may indicate the following problems:
</para>
106 <term><constant>-EINVAL
</constant></term>
108 <listitem><para>The call message
<parameter>call
</parameter> is
109 <constant>NULL
</constant>.
</para>
111 <para>Message
<parameter>call
</parameter> is not a method call message.
114 <para>Message
<parameter>call
</parameter> is not attached to a bus.
</para>
116 <para>The error
<parameter>error
</parameter> parameter to
117 <function>sd_bus_reply_method_error
</function> is not set, see
118 <citerefentry><refentrytitle>sd_bus_error_is_set
</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
124 <term><constant>-EPERM
</constant></term>
126 <listitem><para>Message
<parameter>call
</parameter> has been sealed.
131 <term><constant>-ENOTCONN
</constant></term>
133 <listitem><para>The bus to which message
<parameter>call
</parameter> is
134 attached is not connected.
</para></listitem>
138 <term><constant>-ENOMEM
</constant></term>
140 <listitem><para>Memory allocation failed.
</para></listitem>
144 <para>In addition, any error message returned by
145 <citerefentry><refentrytitle>sd_bus_send
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
146 may be returned.
</para>
149 <xi:include href=
"libsystemd-pkgconfig.xml" />
152 <title>See Also
</title>
155 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
156 <citerefentry><refentrytitle>sd-bus
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
157 <citerefentry><refentrytitle>sd_bus_message_new_method_error
</refentrytitle><manvolnum>3</manvolnum></citerefentry>