2011-12-19 06:02:17 +04:00
<?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">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
2011-12-19 06:02:17 +04:00
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2011-12-19 06:02:17 +04:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2011-12-19 06:02:17 +04:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
2013-02-03 07:47:47 +04:00
<refentry id= "sd_get_seats" conditional= 'HAVE_PAM' >
2011-12-19 06:02:17 +04:00
<refentryinfo >
<title > sd_get_seats</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > sd_get_seats</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > sd_get_seats</refname>
<refname > sd_get_sessions</refname>
<refname > sd_get_uids</refname>
2013-04-25 00:54:17 +04:00
<refname > sd_get_machine_names</refname>
<refpurpose > Determine available seats, sessions, logged in users and virtual machines/containers</refpurpose>
2011-12-19 06:02:17 +04:00
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < systemd/sd-login.h> </funcsynopsisinfo>
<funcprototype >
<funcdef > int <function > sd_get_seats</function> </funcdef>
2014-05-08 03:28:46 +04:00
<paramdef > char ***<parameter > seats</parameter> </paramdef>
2011-12-19 06:02:17 +04:00
</funcprototype>
<funcprototype >
<funcdef > int <function > sd_get_sessions</function> </funcdef>
2014-05-08 03:28:46 +04:00
<paramdef > char ***<parameter > sessions</parameter> </paramdef>
2011-12-19 06:02:17 +04:00
</funcprototype>
<funcprototype >
<funcdef > int <function > sd_get_uids</function> </funcdef>
2014-05-08 03:28:46 +04:00
<paramdef > uid_t **<parameter > users</parameter> </paramdef>
2011-12-19 06:02:17 +04:00
</funcprototype>
2013-04-25 00:54:17 +04:00
<funcprototype >
<funcdef > int <function > sd_get_machine_names</function> </funcdef>
2014-05-08 03:28:46 +04:00
<paramdef > char ***<parameter > machines</parameter> </paramdef>
2013-04-25 00:54:17 +04:00
</funcprototype>
2011-12-19 06:02:17 +04:00
</funcsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <function > sd_get_seats()</function> may be used
to determine all currently available local
2013-06-27 03:47:34 +04:00
seats. Returns a <constant > NULL</constant> terminated array of seat
2011-12-19 17:42:59 +04:00
identifiers. The returned array and all strings it
references need to be freed with the libc
2011-12-19 06:02:17 +04:00
<citerefentry > <refentrytitle > free</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
2011-12-19 17:42:59 +04:00
call after use. Note that instead of an empty array
2013-06-27 03:47:34 +04:00
<constant > NULL</constant> may be returned and should be considered
2011-12-19 17:42:59 +04:00
equivalent to an empty array.</para>
2011-12-19 06:02:17 +04:00
2013-12-26 05:47:43 +04:00
<para > Similarly, <function > sd_get_sessions()</function> may
2011-12-19 06:02:17 +04:00
be used to determine all current login sessions.</para>
2013-12-26 05:47:43 +04:00
<para > Similarly, <function > sd_get_uids()</function> may
2011-12-19 06:02:17 +04:00
be used to determine all Unix users who currently have login sessions.</para>
2012-08-09 17:57:01 +04:00
2013-12-26 05:47:43 +04:00
<para > Similarly,
2013-04-25 00:54:17 +04:00
<function > sd_get_machine_names()</function> may be
used to determine all current virtual machines and
containers on the system.</para>
2012-08-09 17:57:01 +04:00
<para > Note that the returned lists are not sorted and in an undefined order.</para>
2011-12-19 06:02:17 +04:00
</refsect1>
<refsect1 >
<title > Return Value</title>
2013-12-26 05:47:44 +04:00
<para > On success, <function > sd_get_seats()</function> ,
2013-04-25 00:54:17 +04:00
<function > sd_get_sessions()</function> ,
<function > sd_get_uids()</function> and
<function > sd_get_machine_names()</function> return the
number of entries in the arrays. On failure, these
calls return a negative errno-style error code.</para>
2011-12-19 06:02:17 +04:00
</refsect1>
<refsect1 >
<title > Notes</title>
<para > The <function > sd_get_seats()</function> ,
2013-04-25 00:54:17 +04:00
<function > sd_get_sessions()</function> ,
<function > sd_get_uids()</function> and
<function > sd_get_machine_names()</function> interfaces
2013-12-26 05:47:43 +04:00
are available as a shared library, which can be compiled
2011-12-19 06:02:17 +04:00
and linked to with the
2014-02-19 21:30:41 +04:00
<constant > libsystemd</constant> <citerefentry > <refentrytitle > pkg-config</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
2011-12-19 06:02:17 +04:00
file.</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2012-07-13 03:50:05 +04:00
<citerefentry > <refentrytitle > sd-login</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
2011-12-19 17:42:59 +04:00
<citerefentry > <refentrytitle > sd_session_get_seat</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
2011-12-19 06:02:17 +04:00
</para>
</refsect1>
</refentry>