man: update docs with the new functions and other enhancements

[thirdparty/systemd.git] / man / sd_bus_message_new.xml

diff --git a/man/sd_bus_message_new.xml b/man/sd_bus_message_new.xml
index e7cb0c57913bf7b8164e56220216f1da917b8537..efe650dea7e46e84ba0e20b01143f8b94aa7289c 100644 (file)
--- a/man/sd_bus_message_new.xml
+++ b/man/sd_bus_message_new.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0'?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
@@ -23,6 +23,7 @@
     <refname>SD_BUS_MESSAGE_METHOD_RETURN</refname>
     <refname>SD_BUS_MESSAGE_METHOD_ERROR</refname>
     <refname>SD_BUS_MESSAGE_SIGNAL</refname>
+    <refname>sd_bus_message_get_bus</refname>
 
     <refpurpose>Create a new bus message object and create or destroy references to it</refpurpose>
   </refnamediv>
@@ -59,6 +60,11 @@
         <funcdef>void <function>sd_bus_message_unrefp</function></funcdef>
         <paramdef>sd_bus_message **<parameter>mp</parameter></paramdef>
       </funcprototype>
+
+      <funcprototype>
+        <funcdef>sd_bus *<function>sd_bus_message_get_bus</function></funcdef>
+        <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -117,6 +123,9 @@
     its argument, which must not be <constant>NULL</constant>, and will execute no operation if
     <emphasis>that</emphasis> is <constant>NULL</constant>.
     </para>
+
+    <para><function>sd_bus_message_get_bus()</function> returns the bus object that message
+    <parameter>m</parameter> is attached to.</para>
   </refsect1>
 
   <refsect1>
@@ -130,33 +139,35 @@
 
     <para><function>sd_bus_message_unref()</function> always returns
     <constant>NULL</constant>.</para>
-  </refsect1>
 
-  <refsect1>
-    <title>Errors</title>
+    <para><function>sd_bus_message_get_bus()</function> always returns the bus object.</para>
+
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>Specified <parameter>type</parameter> is invalid.</para></listitem>
-      </varlistentry>
+          <listitem><para>Specified <parameter>type</parameter> is invalid.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOTCONN</constant></term>
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
 
-        <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
-        the bus is not connected.</para></listitem>
-      </varlistentry>
+          <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or
+          the bus is not connected.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ENOMEM</constant></term>
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Memory allocation failed.</para></listitem>
-      </varlistentry>
-    </variablelist>
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />