2011-12-19 03:02:17 +01:00
|
|
|
|
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
2015-06-18 19:47:44 +02:00
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
2011-12-19 03:02:17 +01:00
|
|
|
|
|
|
|
|
|
<!--
|
2017-11-18 17:22:32 +01:00
|
|
|
|
SPDX-License-Identifier: LGPL-2.1+
|
|
|
|
|
|
2011-12-19 03:02:17 +01:00
|
|
|
|
This file is part of systemd.
|
|
|
|
|
|
|
|
|
|
Copyright 2010 Lennart Poettering
|
|
|
|
|
-->
|
|
|
|
|
|
2013-02-03 04:47:47 +01:00
|
|
|
|
<refentry id="sd_get_seats" conditional='HAVE_PAM'>
|
2011-12-19 03:02:17 +01:00
|
|
|
|
|
2015-02-04 03:14:13 +01: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>
|
|
|
|
|
<refname>sd_get_machine_names</refname>
|
|
|
|
|
<refpurpose>Determine available seats, sessions, logged in users and virtual machines/containers</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<funcsynopsis>
|
|
|
|
|
<funcsynopsisinfo>#include <systemd/sd-login.h></funcsynopsisinfo>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_get_seats</function></funcdef>
|
|
|
|
|
<paramdef>char ***<parameter>seats</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_get_sessions</function></funcdef>
|
|
|
|
|
<paramdef>char ***<parameter>sessions</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_get_uids</function></funcdef>
|
|
|
|
|
<paramdef>uid_t **<parameter>users</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_get_machine_names</function></funcdef>
|
|
|
|
|
<paramdef>char ***<parameter>machines</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
</funcsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
|
|
<para><function>sd_get_seats()</function> may be used to determine
|
2017-05-31 17:27:47 +02:00
|
|
|
|
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.
|
2015-02-04 03:14:13 +01:00
|
|
|
|
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>
|
|
|
|
|
call after use. Note that instead of an empty array
|
|
|
|
|
<constant>NULL</constant> may be returned and should be considered
|
|
|
|
|
equivalent to an empty array.</para>
|
|
|
|
|
|
|
|
|
|
<para>Similarly, <function>sd_get_sessions()</function> may be
|
|
|
|
|
used to determine all current login sessions.</para>
|
|
|
|
|
|
|
|
|
|
<para>Similarly, <function>sd_get_uids()</function> may be used to
|
|
|
|
|
determine all Unix users who currently have login sessions.</para>
|
|
|
|
|
|
|
|
|
|
<para>Similarly, <function>sd_get_machine_names()</function> may
|
|
|
|
|
be used to determine all current virtual machines and containers
|
|
|
|
|
on the system.</para>
|
|
|
|
|
|
|
|
|
|
<para>Note that the returned lists are not sorted and in an
|
|
|
|
|
undefined order.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Return Value</title>
|
|
|
|
|
|
|
|
|
|
<para>On success, <function>sd_get_seats()</function>,
|
|
|
|
|
<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>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
2015-09-04 09:05:52 +02:00
|
|
|
|
<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>
|
|
|
|
|
|
2015-02-04 03:14:13 +01:00
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Notes</title>
|
|
|
|
|
|
|
|
|
|
<para>The <function>sd_get_seats()</function>,
|
|
|
|
|
<function>sd_get_sessions()</function>,
|
|
|
|
|
<function>sd_get_uids()</function> and
|
|
|
|
|
<function>sd_get_machine_names()</function> interfaces are
|
|
|
|
|
available as a shared library, which can be compiled and linked to
|
|
|
|
|
with the
|
|
|
|
|
<constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
|
|
|
file.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
2011-12-19 03:02:17 +01:00
|
|
|
|
|
|
|
|
|
</refentry>
|