diff options
| author | Daan De Meyer <daan.j.demeyer@gmail.com> | 2020-03-16 20:41:57 +0100 |
|---|---|---|
| committer | Yu Watanabe <watanabe.yu+github@gmail.com> | 2020-03-17 17:12:58 +0900 |
| commit | 9735c644be672f5ba3b319417e266648ed133d42 (patch) | |
| tree | 2e8b84d0ac812c8d1b973bb26b6f2829ecf5d2c6 /man/sd_bus_message_new_method_call.xml | |
| parent | a4f4a4e44100025cfbe01b042db386e0e933c627 (diff) | |
| download | systemd-9735c644be672f5ba3b319417e266648ed133d42.tar.gz | |
sd-bus: Add sd_bus_method_call/sd_bus_method_call_async docs + cleanups.
Diffstat (limited to 'man/sd_bus_message_new_method_call.xml')
| -rw-r--r-- | man/sd_bus_message_new_method_call.xml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/man/sd_bus_message_new_method_call.xml b/man/sd_bus_message_new_method_call.xml index 0d181ed82e..1201262690 100644 --- a/man/sd_bus_message_new_method_call.xml +++ b/man/sd_bus_message_new_method_call.xml @@ -28,7 +28,7 @@ <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> <funcprototype> - <funcdef>int sd_bus_message_new_method_call</funcdef> + <funcdef>int <function>sd_bus_message_new_method_call</function></funcdef> <paramdef>sd_bus *<parameter>bus</parameter></paramdef> <paramdef>sd_bus_message **<parameter>m</parameter></paramdef> <paramdef>const char *<parameter>destination</parameter></paramdef> @@ -38,7 +38,7 @@ </funcprototype> <funcprototype> - <funcdef>int sd_bus_message_new_method_return</funcdef> + <funcdef>int <function>sd_bus_message_new_method_return</function></funcdef> <paramdef>sd_bus_message *<parameter>call</parameter></paramdef> <paramdef>sd_bus_message **<parameter>m</parameter></paramdef> </funcprototype> @@ -70,7 +70,11 @@ has only a single member with the given name and there is no ambiguity if the interface name is omitted.</para> - <para>The <function>sd_bus_message_new_method_call()</function> function creates a new bus + <para>Note that this is a low level interface. See + <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry> + for a more convenient way of calling D-Bus methods.</para> + + <para>The <function>sd_bus_message_new_method_return()</function> function creates a new bus message object that is a reply to the method call <parameter>call</parameter> and returns it in the <parameter>m</parameter> output parameter. The <parameter>call</parameter> parameter must be a method call message. The sender of <parameter>call</parameter> is used as the destination. @@ -80,8 +84,8 @@ <refsect1> <title>Return Value</title> - <para>This function returns 0 if the message object was successfully created, and a negative - errno-style error code otherwise.</para> + <para>On success, these functions returns a non-negative integer. On failure, they return a + negative errno-style error code.</para> <refsect2 id='errors'> <title>Errors</title> @@ -160,6 +164,7 @@ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry> </para> </refsect1> |