]>
Commit | Line | Data |
---|---|---|
62994100 | 1 | <?xml version='1.0'?> |
3a54a157 ZJS |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
0307f791 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
62994100 ZJS |
5 | |
6 | <refentry id="sd_bus_reply_method_error" | |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
8 | ||
9 | <refentryinfo> | |
10 | <title>sd_bus_reply_method_error</title> | |
11 | <productname>systemd</productname> | |
12 | </refentryinfo> | |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>sd_bus_reply_method_error</refentrytitle> | |
16 | <manvolnum>3</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>sd_bus_reply_method_error</refname> | |
21 | <refname>sd_bus_reply_method_errorf</refname> | |
22 | <refname>sd_bus_reply_method_errno</refname> | |
23 | <refname>sd_bus_reply_method_errnof</refname> | |
24 | ||
25 | <refpurpose>Reply with an error to a method call</refpurpose> | |
26 | </refnamediv> | |
27 | ||
28 | <refsynopsisdiv> | |
29 | <funcsynopsis> | |
30 | <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> | |
31 | ||
32 | <funcprototype> | |
33 | <funcdef>int sd_bus_reply_method_error</funcdef> | |
34 | <paramdef>sd_bus_message *<parameter>call</parameter></paramdef> | |
35 | <paramdef>const sd_bus_error *<parameter>e</parameter></paramdef> | |
36 | </funcprototype> | |
37 | ||
38 | <funcprototype> | |
39 | <funcdef>int sd_bus_reply_method_errorf</funcdef> | |
40 | <paramdef>sd_bus_message *<parameter>call</parameter></paramdef> | |
41 | <paramdef>const char *<parameter>name</parameter></paramdef> | |
42 | <paramdef>const char *<parameter>format</parameter></paramdef> | |
43 | <paramdef>…</paramdef> | |
44 | </funcprototype> | |
45 | ||
46 | <funcprototype> | |
47 | <funcdef>int sd_bus_reply_method_errno</funcdef> | |
48 | <paramdef>sd_bus_message *<parameter>call</parameter></paramdef> | |
49 | <paramdef>int <parameter>error</parameter></paramdef> | |
50 | <paramdef>const sd_bus_error *<parameter>p</parameter></paramdef> | |
51 | </funcprototype> | |
52 | ||
53 | <funcprototype> | |
54 | <funcdef>int sd_bus_reply_method_errnof</funcdef> | |
55 | <paramdef>sd_bus_message *<parameter>call</parameter></paramdef> | |
56 | <paramdef>int <parameter>error</parameter></paramdef> | |
57 | <paramdef>const char *<parameter>format</parameter></paramdef> | |
58 | <paramdef>…</paramdef> | |
59 | </funcprototype> | |
60 | </funcsynopsis> | |
61 | </refsynopsisdiv> | |
62 | ||
63 | <refsect1> | |
64 | <title>Description</title> | |
65 | ||
66 | <para>The <function>sd_bus_reply_method_error()</function> function sends an | |
67 | error reply to the <parameter>call</parameter> message. The error structure | |
68 | <parameter>e</parameter> specifies the error to send, and is used as described in | |
69 | <citerefentry><refentrytitle>sd_bus_message_new_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
70 | If no reply is expected to <parameter>call</parameter>, this function returns | |
71 | success without sending reply.</para> | |
72 | ||
73 | <para>The <function>sd_bus_reply_method_errorf()</function> is to | |
74 | <function>sd_bus_reply_method_error()</function> what | |
75 | <function>sd_bus_message_new_method_errorf()</function> is to | |
76 | <function>sd_bus_message_new_method_error()</function>.</para> | |
77 | ||
78 | <para>The <function>sd_bus_reply_method_errno()</function> is to | |
79 | <function>sd_bus_reply_method_error()</function> what | |
80 | <function>sd_bus_message_new_method_errno()</function> is to | |
81 | <function>sd_bus_message_new_method_error()</function>.</para> | |
82 | ||
83 | <para>The <function>sd_bus_reply_method_errnof()</function> is to | |
84 | <function>sd_bus_reply_method_error()</function> what | |
85 | <function>sd_bus_message_new_method_errnof()</function> is to | |
86 | <function>sd_bus_message_new_method_error()</function>.</para> | |
87 | </refsect1> | |
88 | ||
89 | <refsect1> | |
90 | <title>Return Value</title> | |
91 | ||
92 | <para>These functions return 0 if the error reply was successfully sent or if | |
93 | none was expected, and a negative errno-style error code otherwise.</para> | |
94 | </refsect1> | |
95 | ||
96 | <refsect1 id='errors'> | |
97 | <title>Errors</title> | |
98 | ||
99 | <para>Returned errors may indicate the following problems:</para> | |
100 | ||
101 | <variablelist> | |
102 | <varlistentry> | |
103 | <term><constant>-EINVAL</constant></term> | |
104 | ||
105 | <listitem><para>The call message <parameter>call</parameter> is | |
106 | <constant>NULL</constant>.</para> | |
107 | ||
108 | <para>Message <parameter>call</parameter> is not a method call message. | |
109 | </para> | |
110 | ||
111 | <para>Message <parameter>call</parameter> is not attached to a bus.</para> | |
112 | ||
113 | <para>The error <parameter>error</parameter> parameter to | |
114 | <function>sd_bus_reply_method_error</function> is not set, see | |
115 | <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>. | |
116 | </para> | |
117 | </listitem> | |
118 | </varlistentry> | |
119 | ||
120 | <varlistentry> | |
121 | <term><constant>-EPERM</constant></term> | |
122 | ||
123 | <listitem><para>Message <parameter>call</parameter> has been sealed. | |
124 | </para></listitem> | |
125 | </varlistentry> | |
126 | ||
127 | <varlistentry> | |
128 | <term><constant>-ENOTCONN</constant></term> | |
129 | ||
130 | <listitem><para>The bus to which message <parameter>call</parameter> is | |
131 | attached is not connected.</para></listitem> | |
132 | </varlistentry> | |
133 | ||
134 | <varlistentry> | |
135 | <term><constant>-ENOMEM</constant></term> | |
136 | ||
137 | <listitem><para>Memory allocation failed.</para></listitem> | |
138 | </varlistentry> | |
139 | </variablelist> | |
140 | ||
141 | <para>In addition, any error message returned by | |
142 | <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
143 | may be returned.</para> | |
144 | </refsect1> | |
145 | ||
146 | <xi:include href="libsystemd-pkgconfig.xml" /> | |
147 | ||
148 | <refsect1> | |
149 | <title>See Also</title> | |
150 | ||
151 | <para> | |
152 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
153 | <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
154 | <citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
155 | </para> | |
156 | </refsect1> | |
157 | ||
158 | </refentry> |