diff options
author | Yu Watanabe <watanabe.yu+github@gmail.com> | 2020-11-10 05:57:41 +0900 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-12-08 18:08:31 +0100 |
commit | cc1b93aef99667ea5876db91b54f36f43070f415 (patch) | |
tree | 1efb88a5f06d49620bce6246482dc6544930369f | |
parent | 0e233e5987582ab3161a8e0dfc04a18a33c88df0 (diff) | |
download | systemd-cc1b93aef99667ea5876db91b54f36f43070f415.tar.gz |
man: mention that sd_bus_call() may return a negative errno mapped from D-Bus error reply
Closes #17556.
(cherry picked from commit c660668ed9daf15358c522c09ba3932393bd5451)
-rw-r--r-- | man/sd_bus_call.xml | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml index f47f9c8526..b52f65a8d3 100644 --- a/man/sd_bus_call.xml +++ b/man/sd_bus_call.xml @@ -104,7 +104,12 @@ <refsect2 id='errors'> <title>Errors</title> - <para>Returned errors may indicate the following problems:</para> + <para>Returned errors may indicate the following problems. When + <function>sd_bus_call()</function> internally receives a D-Bus error reply, it will set + <parameter>ret_error</parameter> if it is not <constant>NULL</constant>, and will return a + negative value mapped from the error reply. See + <citerefentry><refentrytitle>sd_bus_error_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + </para> <variablelist> <varlistentry> @@ -180,7 +185,8 @@ <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry> </para> </refsect1> |