sd-login: rework error handling

[elogind.git] / man / sd_seat_get_active.xml

diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
index 793bbc8c97a691ddd19692cffa6b16a7183beea1..6dda53512a0c2b4feebb7a765b0f09e5ef9487c4 100644 (file)
--- a/man/sd_seat_get_active.xml
+++ b/man/sd_seat_get_active.xml
@@ -148,6 +148,43 @@
     errno-style error code.</para>
   </refsect1>
 
+  <refsect1>
+    <title>Errors</title>
+
+    <para>Returned errors may indicate the following problems:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><constant>-ENODATA</constant></term>
+
+        <listitem><para>Given field is not specified for the described
+        seat.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-ENXIO</constant></term>
+
+        <listitem><para>The specified seat is unknown.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-EINVAL</constant></term>
+
+        <listitem><para>An input parameter was invalid (out of range,
+        or NULL, where that's not accepted).</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-ENOMEM</constant></term>
+
+        <listitem><para>Memory allocation failed.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1>
     <title>Notes</title>