summaryrefslogtreecommitdiff
path: root/man/sd_bus_message_new_method_call.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-07-27 14:07:02 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-08-02 15:49:45 +0200
commit7ddee2171627d6ce059a6a66b46b0b4367b77bd5 (patch)
treef5ec866acdd2f6bf6b58c845a45cf1ffb0ad2d20 /man/sd_bus_message_new_method_call.xml
parent65889ab72d4e7f265dedb7d4720f3f470e3e802e (diff)
downloadsystemd-7ddee2171627d6ce059a6a66b46b0b4367b77bd5.tar.gz
man: document sd_bus_message_new_method_return
Diffstat (limited to 'man/sd_bus_message_new_method_call.xml')
-rw-r--r--man/sd_bus_message_new_method_call.xml34
1 files changed, 33 insertions, 1 deletions
diff --git a/man/sd_bus_message_new_method_call.xml b/man/sd_bus_message_new_method_call.xml
index 1226f1050c..c643177ba4 100644
--- a/man/sd_bus_message_new_method_call.xml
+++ b/man/sd_bus_message_new_method_call.xml
@@ -18,6 +18,7 @@
<refnamediv>
<refname>sd_bus_message_new_method_call</refname>
+ <refname>sd_bus_message_new_method_return</refname>
<refpurpose>Create a method call message</refpurpose>
</refnamediv>
@@ -35,6 +36,12 @@
<paramdef>const char *<parameter>interface</parameter></paramdef>
<paramdef>const char *<parameter>member</parameter></paramdef>
</funcprototype>
+
+ <funcprototype>
+ <funcdef>int sd_bus_message_new_method_return</funcdef>
+ <paramdef>sd_bus_message *<parameter>call</parameter></paramdef>
+ <paramdef>sd_bus_message **<parameter>m</parameter></paramdef>
+ </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -62,6 +69,12 @@
<parameter>interface</parameter> parameter may be <constant>NULL</constant>, if the destination
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
+ 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.
+ </para>
</refsect1>
<refsect1>
@@ -88,7 +101,10 @@
parameter is not a valid D-Bus path (<literal>/an/object/path</literal>), the
<parameter>interface</parameter> parameter is non-null and is not a valid D-Bus interface
name (<literal>an.interface.name</literal>), or the <parameter>member</parameter> parameter
- is not a valid D-Bus member (<literal>Name</literal>).</para></listitem>
+ is not a valid D-Bus member (<literal>Name</literal>).</para>
+
+ <para>The <parameter>call</parameter> parameter is not a method call object.</para>
+ </listitem>
</varlistentry>
<varlistentry>
@@ -103,6 +119,22 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><constant>-EPERM</constant></term>
+
+ <listitem>
+ <para>The <parameter>call</parameter> parameter is not sealed.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><constant>-EOPNOTSUPP</constant></term>
+
+ <listitem>
+ <para>The <parameter>call</parameter> message does not have a cookie.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>