]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_get_seats.xml
man: systemd: fix typo (#7746)
[thirdparty/systemd.git] / man / sd_get_seats.xml
index 3f2c666c6145a2f6e287ba0a18c9ce09321110e8..b4b133ff0fb1f5287e2edc68a9080ea19e595a32 100644 (file)
@@ -1,11 +1,10 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
-<!ENTITY % entities SYSTEM "custom-entities.ent" >
-%entities;
-]>
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
+  SPDX-License-Identifier: LGPL-2.1+
+
   This file is part of systemd.
 
   Copyright 2010 Lennart Poettering
     <title>Description</title>
 
     <para><function>sd_get_seats()</function> may be used to determine
-    all currently available local seats. Returns a
-    <constant>NULL</constant> terminated array of seat identifiers.
+    all currently available local seats. Returns the number of seat
+    identifiers and if the input pointer is non-NULL, a
+    <constant>NULL</constant>-terminated array of seat identifiers
+    is stored at the address.
     The returned array and all strings it references need to be freed
     with the libc
     <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     errno-style error code.</para>
   </refsect1>
 
+
+  <refsect1>
+    <title>Errors</title>
+
+    <para>Returned errors may indicate the following problems:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><constant>-ENOMEM</constant></term>
+
+        <listitem><para>Memory allocation failed.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1>
     <title>Notes</title>