X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_uid_get_state.xml;h=1007a7917b3abc6a7d001473ae8ecde4ccce3399;hp=9a20b5453cdc356cd59d03a93212d1e8075c6f9c;hb=03ee5c38cb0da193dd08733fb4c0c2809cee6a99;hpb=74d005783e355acc784d123024e33bbb66ef9ef1
diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
index 9a20b5453..1007a7917 100644
--- a/man/sd_uid_get_state.xml
+++ b/man/sd_uid_get_state.xml
@@ -47,6 +47,7 @@
sd_uid_is_on_seat
sd_uid_get_sessions
sd_uid_get_seats
+ sd_uid_get_display
Determine login state of a specific Unix user ID
@@ -57,28 +58,34 @@
int sd_uid_get_state
uid_t uid
- char** state
+ char **state
int sd_uid_is_on_seat
uid_t uid
int require_active
- const char* seat
+ const char *seat
int sd_uid_get_sessions
uid_t uid
int require_active
- char*** sessions
+ char ***sessions
int sd_uid_get_seats
uid_t uid
int require_active
- char*** seats
+ char ***seats
+
+
+
+ int sd_uid_get_display
+ uid_t uid
+ char **session
@@ -111,7 +118,7 @@
or active on a specific seat. Accepts a Unix user
identifier and a seat identifier string as
parameters. The require_active
- parameter is a boolean value. If non-zero (true) this
+ parameter is a boolean value. If non-zero (true), this
function will test if the user is active (i.e. has a
session that is in the foreground and accepting user
input) on the specified seat, otherwise (false) only
@@ -133,13 +140,13 @@
free3
call after use, including all the strings
referenced. If the string array parameter is passed as
- NULL the array will not be filled in, but the return
+ NULL, the array will not be filled in, but the return
code still indicates the number of current
sessions. Note that instead of an empty array NULL may
be returned and should be considered equivalent to an
empty array.
- Similar, sd_uid_get_seats()
+ Similarly, sd_uid_get_seats()
may be used to determine the list of seats on which
the user currently has sessions. Similar semantics
apply, however note that the user may have
@@ -147,19 +154,27 @@
with no attached seat and hence the number of entries
in the returned array may differ from the one returned
by sd_uid_get_sessions().
+
+ sd_uid_get_display()
+ returns the name of the "primary" session of a user.
+ If the user has graphical sessions, it will be the
+ oldest graphical session. Otherwise, it will be the
+ oldest open session.
Return Value
- On success
+ On success,
sd_uid_get_state() returns 0 or a
- positive integer. If the test succeeds
+ positive integer. If the test succeeds,
sd_uid_is_on_seat() returns a
- positive integer, if it fails
+ positive integer; if it fails,
0. sd_uid_get_sessions() and
sd_uid_get_seats() return the
- number of entries in the returned arrays. On failure,
+ number of entries in the returned arrays.
+ sd_uid_get_display() returns
+ a non-negative code on success. On failure,
these calls return a negative errno-style error
code.
@@ -167,14 +182,24 @@
Notes
- The sd_uid_get_state(),
+ Functions described here are available as a
+ shared library, and can be compiled and linked to
+ using the
+ libsystemd pkg-config1
+ entry.
+
+
+
+ History
+
+ sd_uid_get_state(),
sd_uid_is_on_seat(),
- sd_uid_get_sessions(), and
- sd_uid_get_seats() interfaces are
- available as shared library, which can be compiled and
- linked to with the libsystemd-login
- pkg-config1
- file.
+ sd_uid_get_sessions(),
+ and sd_uid_get_seats() functions
+ were added in systemd-31.
+
+ sd_uid_get_display() was
+ added in systemd-213.