man/sd_get_seats.xml

   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">
   4
   5 <!--
   6   This file is part of elogind.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   elogind is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   elogind is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with elogind; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="sd_get_seats" conditional='HAVE_PAM'>
  25
  26   <refentryinfo>
  27     <title>sd_get_seats</title>
  28     <productname>elogind</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>sd_get_seats</refentrytitle>
  42     <manvolnum>3</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>sd_get_seats</refname>
  47     <refname>sd_get_sessions</refname>
  48     <refname>sd_get_uids</refname>
  49     <refname>sd_get_machine_names</refname>
  50     <refpurpose>Determine available seats, sessions, logged in users and virtual machines/containers</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <funcsynopsis>
  55       <funcsynopsisinfo>#include &lt;elogind/sd-login.h&gt;</funcsynopsisinfo>
  56
  57       <funcprototype>
  58         <funcdef>int <function>sd_get_seats</function></funcdef>
  59         <paramdef>char ***<parameter>seats</parameter></paramdef>
  60       </funcprototype>
  61
  62       <funcprototype>
  63         <funcdef>int <function>sd_get_sessions</function></funcdef>
  64         <paramdef>char ***<parameter>sessions</parameter></paramdef>
  65       </funcprototype>
  66
  67       <funcprototype>
  68         <funcdef>int <function>sd_get_uids</function></funcdef>
  69         <paramdef>uid_t **<parameter>users</parameter></paramdef>
  70       </funcprototype>
  71
  72       <funcprototype>
  73         <funcdef>int <function>sd_get_machine_names</function></funcdef>
  74         <paramdef>char ***<parameter>machines</parameter></paramdef>
  75       </funcprototype>
  76
  77     </funcsynopsis>
  78   </refsynopsisdiv>
  79
  80   <refsect1>
  81     <title>Description</title>
  82
  83     <para><function>sd_get_seats()</function> may be used to determine
  84     all currently available local seats. Returns the number of seat
  85     identifiers and if the input pointer is non-NULL, a
  86     <constant>NULL</constant>-terminated array of seat identifiers
  87     is stored at the address.
  88     The returned array and all strings it references need to be freed
  89     with the libc
  90     <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
  91     call after use. Note that instead of an empty array
  92     <constant>NULL</constant> may be returned and should be considered
  93     equivalent to an empty array.</para>
  94
  95     <para>Similarly, <function>sd_get_sessions()</function> may be
  96     used to determine all current login sessions.</para>
  97
  98     <para>Similarly, <function>sd_get_uids()</function> may be used to
  99     determine all Unix users who currently have login sessions.</para>
 100
 101     <para>Similarly, <function>sd_get_machine_names()</function> may
 102     be used to determine all current virtual machines and containers
 103     on the system.</para>
 104
 105     <para>Note that the returned lists are not sorted and in an
 106     undefined order.</para>
 107   </refsect1>
 108
 109   <refsect1>
 110     <title>Return Value</title>
 111
 112     <para>On success, <function>sd_get_seats()</function>,
 113     <function>sd_get_sessions()</function>,
 114     <function>sd_get_uids()</function> and
 115     <function>sd_get_machine_names()</function> return the number of
 116     entries in the arrays. On failure, these calls return a negative
 117     errno-style error code.</para>
 118   </refsect1>
 119
 120
 121   <refsect1>
 122     <title>Errors</title>
 123
 124     <para>Returned errors may indicate the following problems:</para>
 125
 126     <variablelist>
 127
 128       <varlistentry>
 129         <term><constant>-ENOMEM</constant></term>
 130
 131         <listitem><para>Memory allocation failed.</para></listitem>
 132       </varlistentry>
 133     </variablelist>
 134   </refsect1>
 135
 136   <refsect1>
 137     <title>Notes</title>
 138
 139     <para>The <function>sd_get_seats()</function>,
 140     <function>sd_get_sessions()</function>,
 141     <function>sd_get_uids()</function> and
 142     <function>sd_get_machine_names()</function> interfaces are
 143     available as a shared library, which can be compiled and linked to
 144     with the
 145     <constant>libelogind</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 146     file.</para>
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>See Also</title>
 151
 152     <para>
 153       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 154       <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 156     </para>
 157   </refsect1>
 158
 159 </refentry>