sd-bus: Add sd_bus_list_names docs

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 222c0d2919befbcef1c0caffebc42e2ed29bfadb..f11382ab83ef308a8c0392dbcf3e2cfd4c7a1463 100644 (file)
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -263,6 +263,7 @@ manpages = [
   ''],
  ['sd_bus_get_n_queued_read', '3', ['sd_bus_get_n_queued_write'], ''],
  ['sd_bus_is_open', '3', ['sd_bus_is_ready'], ''],
+ ['sd_bus_list_names', '3', [], ''],
  ['sd_bus_message_append', '3', ['sd_bus_message_appendv'], ''],
  ['sd_bus_message_append_array',
   '3',

diff --git a/man/sd-bus.xml b/man/sd-bus.xml
index 9918e0c737b537f2c6617d0975f80796a3ac31bd..e8792cd6c948bd9658a815371a25d596dfe6839e 100644 (file)
--- a/man/sd-bus.xml
+++ b/man/sd-bus.xml
@@ -86,6 +86,7 @@
 <citerefentry><refentrytitle>sd_bus_get_unique_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_list_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

diff --git a/man/sd_bus_list_names.xml b/man/sd_bus_list_names.xml
new file mode 100644 (file)
index 0000000..d1aba6e
--- /dev/null
+++ b/man/sd_bus_list_names.xml
@@ -0,0 +1,111 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!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+ -->
+
+<refentry id="sd_bus_list_names"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <refentryinfo>
+    <title>sd_bus_list_names</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>sd_bus_list_names</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>sd_bus_list_names</refname>
+
+    <refpurpose>Retrieve information about registered names on a bus</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_list_names</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+        <paramdef>char ***<parameter>acquired</parameter></paramdef>
+        <paramdef>char ***<parameter>activatable</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><function>sd_bus_list_names()</function> retrieves information about the registered names on a bus.
+    If <parameter>acquired</parameter> is not <constant>NULL</constant>, this function calls
+    <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-names">
+    org.freedesktop.DBus.ListNames</ulink> to retrieve the list of currently-owned names on the bus. If
+    <parameter>acquired</parameter> is not <constant>NULL</constant>, the function calls
+    <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-activatable-names">
+    org.freedesktop.DBus.ListActivableNames</ulink> to retrieve the list of all names on the bus that can be
+    activated. Note that ownership of any string arrays returned by <function>sd_bus_list_names()</function>
+    is transferred to the caller and hence, the caller is responsible for freeing any results stored by
+    <function>sd_bus_list_names()</function> in <parameter>acquired</parameter> and
+    <parameter>activatable</parameter>.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+
+    <para>On success, <function>sd_bus_list_names()</function> returns a non-negative integer. On failure,
+    it returns a negative errno-style error code.</para>
+
+    <refsect2>
+      <title>Errors</title>
+
+      <para>Returned errors may indicate the following problems:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
+
+          <listitem><para><parameter>bus</parameter> or both <parameter>acquired</parameter> and
+          <parameter>activatable</parameter> were <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ENOPKG</constant></term>
+
+          <listitem><para>The bus cannot be resolved.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
+
+          <listitem><para>The bus was created in a different process.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ENOMEM</constant></term>
+
+          <listitem><para>Memory allocation failed.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ENOTCONN</constant></term>
+
+          <listitem><para>The bus is not connected.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+  </refsect1>
+
+  <xi:include href="libsystemd-pkgconfig.xml" />
+
+  <refsect1>
+    <title>See Also</title>
+
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+</refentry>