diff options
| author | Daan De Meyer <daan.j.demeyer@gmail.com> | 2020-03-19 19:52:54 +0100 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-03-19 20:51:17 +0100 |
| commit | 60ef0942976adaebb935a48ecbcace3b58e57a76 (patch) | |
| tree | fe9b3c57e51f381c35852a1b37470bfb825982b5 /man/sd_bus_reply_method_error.xml | |
| parent | 4bd859be95e6024ed6020a5f7bed4e8ae9002fc3 (diff) | |
| download | systemd-60ef0942976adaebb935a48ecbcace3b58e57a76.tar.gz | |
sd-bus: Add sd_bus_reply_method_return docs + cleanups
Diffstat (limited to 'man/sd_bus_reply_method_error.xml')
| -rw-r--r-- | man/sd_bus_reply_method_error.xml | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/man/sd_bus_reply_method_error.xml b/man/sd_bus_reply_method_error.xml index 5a6cef6bad..a1062ce2a9 100644 --- a/man/sd_bus_reply_method_error.xml +++ b/man/sd_bus_reply_method_error.xml @@ -22,7 +22,7 @@ <refname>sd_bus_reply_method_errno</refname> <refname>sd_bus_reply_method_errnof</refname> - <refpurpose>Reply with an error to a method call</refpurpose> + <refpurpose>Reply with an error to a D-Bus method call</refpurpose> </refnamediv> <refsynopsisdiv> @@ -63,12 +63,12 @@ <refsect1> <title>Description</title> - <para>The <function>sd_bus_reply_method_error()</function> function sends an - error reply to the <parameter>call</parameter> message. The error structure - <parameter>e</parameter> specifies the error to send, and is used as described in + <para>The <function>sd_bus_reply_method_error()</function> function sends an error reply to the + <parameter>call</parameter> message. The error structure <parameter>e</parameter> specifies the + error to send, and is used as described in <citerefentry><refentrytitle>sd_bus_message_new_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>. - If no reply is expected to <parameter>call</parameter>, this function returns - success without sending reply.</para> + If no reply is expected to <parameter>call</parameter>, this function succeeds without sending a + reply.</para> <para>The <function>sd_bus_reply_method_errorf()</function> is to <function>sd_bus_reply_method_error()</function> what @@ -89,8 +89,9 @@ <refsect1> <title>Return Value</title> - <para>These functions return 0 if the error reply was successfully sent or if - none was expected, and a negative errno-style error code otherwise.</para> + <para>This function returns a non-negative integer if the error reply was successfully sent or + if <parameter>call</parameter> does not expect a reply. On failure, it returns a negative + errno-style error code.</para> <refsect2> <title>Errors</title> @@ -101,15 +102,14 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>The call message <parameter>call</parameter> is + <listitem><para>The input parameter <parameter>call</parameter> is <constant>NULL</constant>.</para> - <para>Message <parameter>call</parameter> is not a method call message. - </para> + <para>Message <parameter>call</parameter> is not a method call message.</para> <para>Message <parameter>call</parameter> is not attached to a bus.</para> - <para>The error <parameter>error</parameter> parameter to + <para>The error parameter <parameter>error</parameter> to <function>sd_bus_reply_method_error</function> is not set, see <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>. </para> @@ -137,7 +137,7 @@ </varlistentry> </variablelist> - <para>In addition, any error message returned by + <para>In addition, any error returned by <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>1</manvolnum></citerefentry> may be returned.</para> </refsect2> |