]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: mention that sd_bus_call() may return a negative errno mapped from D-Bus error...
authorYu Watanabe <watanabe.yu+github@gmail.com>
Mon, 9 Nov 2020 20:57:41 +0000 (05:57 +0900)
committerYu Watanabe <watanabe.yu+github@gmail.com>
Thu, 12 Nov 2020 08:06:33 +0000 (17:06 +0900)
Closes #17556.

man/sd_bus_call.xml

index 2c27f934ac10e7de1493838ab68a5f3ddca6657b..3eeccdb63ee32b5f8fb99a7c8ad32251ce2cb7aa 100644 (file)
     <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>
       <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>