summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/sd_get_seats.3
blob: 3f03e38b39831b576eedc5b221d48f0a073872e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
'\" t
.TH "SD_GET_SEATS" "3" "" "systemd 256~rc3" "sd_get_seats"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_get_seats, sd_get_sessions, sd_get_uids, sd_get_machine_names \- Determine available seats, sessions, logged in users and virtual machines/containers
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-login\&.h>
.fi
.ft
.HP \w'int\ sd_get_seats('u
.BI "int sd_get_seats(char\ ***" "seats" ");"
.HP \w'int\ sd_get_sessions('u
.BI "int sd_get_sessions(char\ ***" "sessions" ");"
.HP \w'int\ sd_get_uids('u
.BI "int sd_get_uids(uid_t\ **" "users" ");"
.HP \w'int\ sd_get_machine_names('u
.BI "int sd_get_machine_names(char\ ***" "machines" ");"
.SH "DESCRIPTION"
.PP
\fBsd_get_seats()\fR
may be used to determine all currently available local seats\&. Returns the number of seat identifiers and if the input pointer is non\-\fBNULL\fR, a
\fBNULL\fR\-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
\fBfree\fR(3)
call after use\&. Note that instead of an empty array
\fBNULL\fR
may be returned and should be considered equivalent to an empty array\&.
.PP
Similarly,
\fBsd_get_sessions()\fR
may be used to determine all current login sessions\&.
.PP
Similarly,
\fBsd_get_uids()\fR
may be used to determine all Unix users who currently have login sessions\&.
.PP
Similarly,
\fBsd_get_machine_names()\fR
may be used to determine all current virtual machines and containers on the system\&.
.PP
Note that the returned lists are not sorted and in an undefined order\&.
.SH "RETURN VALUE"
.PP
On success,
\fBsd_get_seats()\fR,
\fBsd_get_sessions()\fR,
\fBsd_get_uids()\fR
and
\fBsd_get_machine_names()\fR
return the number of entries in the arrays\&. On failure, these calls return a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-ENOMEM\fR
.RS 4
Memory allocation failed\&.
.RE
.SH "NOTES"
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "HISTORY"
.PP
\fBsd_get_machine_names()\fR
was added in version 203\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1), \fBsd-login\fR(3), \fBsd_session_get_seat\fR(3)