1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"sd_get_seats" conditional='HAVE_PAM'
10 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
13 <title>sd_get_seats
</title>
14 <productname>systemd
</productname>
18 <refentrytitle>sd_get_seats
</refentrytitle>
19 <manvolnum>3</manvolnum>
23 <refname>sd_get_seats
</refname>
24 <refname>sd_get_sessions
</refname>
25 <refname>sd_get_uids
</refname>
26 <refname>sd_get_machine_names
</refname>
27 <refpurpose>Determine available seats, sessions, logged in users and virtual machines/containers
</refpurpose>
32 <funcsynopsisinfo>#include
<systemd/sd-login.h
></funcsynopsisinfo>
35 <funcdef>int
<function>sd_get_seats
</function></funcdef>
36 <paramdef>char ***
<parameter>seats
</parameter></paramdef>
40 <funcdef>int
<function>sd_get_sessions
</function></funcdef>
41 <paramdef>char ***
<parameter>sessions
</parameter></paramdef>
45 <funcdef>int
<function>sd_get_uids
</function></funcdef>
46 <paramdef>uid_t **
<parameter>users
</parameter></paramdef>
50 <funcdef>int
<function>sd_get_machine_names
</function></funcdef>
51 <paramdef>char ***
<parameter>machines
</parameter></paramdef>
58 <title>Description
</title>
60 <para><function>sd_get_seats()
</function> may be used to determine
61 all currently available local seats. Returns the number of seat
62 identifiers and if the input pointer is non-NULL, a
63 <constant>NULL
</constant>-terminated array of seat identifiers
64 is stored at the address.
65 The returned array and all strings it references need to be freed
67 <citerefentry project='man-pages'
><refentrytitle>free
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
68 call after use. Note that instead of an empty array
69 <constant>NULL
</constant> may be returned and should be considered
70 equivalent to an empty array.
</para>
72 <para>Similarly,
<function>sd_get_sessions()
</function> may be
73 used to determine all current login sessions.
</para>
75 <para>Similarly,
<function>sd_get_uids()
</function> may be used to
76 determine all Unix users who currently have login sessions.
</para>
78 <para>Similarly,
<function>sd_get_machine_names()
</function> may
79 be used to determine all current virtual machines and containers
82 <para>Note that the returned lists are not sorted and in an
83 undefined order.
</para>
87 <title>Return Value
</title>
89 <para>On success,
<function>sd_get_seats()
</function>,
90 <function>sd_get_sessions()
</function>,
91 <function>sd_get_uids()
</function> and
92 <function>sd_get_machine_names()
</function> return the number of
93 entries in the arrays. On failure, these calls return a negative
94 errno-style error code.
</para>
100 <para>Returned errors may indicate the following problems:
</para>
105 <term><constant>-ENOMEM
</constant></term>
107 <listitem><para>Memory allocation failed.
</para></listitem>
112 <xi:include href=
"libsystemd-pkgconfig.xml" />
115 <title>See Also
</title>
118 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
119 <citerefentry><refentrytitle>sd-login
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
120 <citerefentry><refentrytitle>sd_session_get_seat
</refentrytitle><manvolnum>3</manvolnum></citerefentry>