summaryrefslogtreecommitdiff
path: root/man/sd_bus_call.xml
diff options
context:
space:
mode:
authorYu Watanabe <watanabe.yu+github@gmail.com>2020-11-10 05:57:41 +0900
committerYu Watanabe <watanabe.yu+github@gmail.com>2020-11-12 17:06:33 +0900
commitc660668ed9daf15358c522c09ba3932393bd5451 (patch)
treedd7d18e67f81df718d2085a4faeae1aedc1a2e5d /man/sd_bus_call.xml
parent23243adf69ffed2630c778e021c3cf2e97a6b999 (diff)
downloadsystemd-c660668ed9daf15358c522c09ba3932393bd5451.tar.gz
man: mention that sd_bus_call() may return a negative errno mapped from D-Bus error reply
Closes #17556.
Diffstat (limited to 'man/sd_bus_call.xml')
-rw-r--r--man/sd_bus_call.xml10
1 files changed, 8 insertions, 2 deletions
diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml
index 2c27f934ac..3eeccdb63e 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>