summaryrefslogtreecommitdiff
path: root/man/sd_uid_get_state.xml
diff options
context:
space:
mode:
authorThorsten Kukuk <kukuk@suse.com>2023-02-24 09:47:52 +0100
committerThorsten Kukuk <kukuk@suse.com>2023-02-25 16:14:11 +0100
commitd622fefc008ce1cd3bf62ced4a606d3b5277b9fa (patch)
tree3838080cd81d542930808a5e937f2afae1ff9e2a /man/sd_uid_get_state.xml
parent9cddd367077f8841b5f84786d113ebc4556b06d3 (diff)
downloadsystemd-d622fefc008ce1cd3bf62ced4a606d3b5277b9fa.tar.gz
sd-login: add sd_uid_get_login_time interface #26574
Diffstat (limited to 'man/sd_uid_get_state.xml')
-rw-r--r--man/sd_uid_get_state.xml28
1 files changed, 23 insertions, 5 deletions
diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
index 087a2d539d..e6cf77ff69 100644
--- a/man/sd_uid_get_state.xml
+++ b/man/sd_uid_get_state.xml
@@ -22,6 +22,7 @@
<refname>sd_uid_get_sessions</refname>
<refname>sd_uid_get_seats</refname>
<refname>sd_uid_get_display</refname>
+ <refname>sd_uid_get_login_time</refname>
<refpurpose>Determine login state of a specific Unix user ID</refpurpose>
</refnamediv>
@@ -62,6 +63,12 @@
<paramdef>char **<parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+
+ <funcprototype>
+ <funcdef>int <function>sd_uid_get_login_time</function></funcdef>
+ <paramdef>uid_t <parameter>uid</parameter></paramdef>
+ <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
+ </funcprototype>
</refsynopsisdiv>
<refsect1>
@@ -126,16 +133,27 @@
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.</para>
+
+ <para><function>sd_uid_get_login_time()</function> may be used to
+ determine the time the user's service manager has been invoked,
+ which is the time when the user's first active session, since which
+ they stayed logged in continuously, began. The <parameter>usec</parameter>
+ is in microseconds since the epoch (<constant>CLOCK_REALTIME</constant>).
+ This call will fail with <constant>-ENXIO</constant> if the user is not
+ currently logged in.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
- <para>On success, <function>sd_uid_get_state()</function> returns 0 or a positive integer. If the test
- succeeds, <function>sd_uid_is_on_seat()</function> returns a positive integer; if it fails, 0.
- <function>sd_uid_get_sessions()</function> and <function>sd_uid_get_seats()</function> return the number
- of entries in the returned arrays. <function>sd_uid_get_display()</function> returns a non-negative code
- on success. On failure, these calls return a negative errno-style error code.</para>
+ <para>On success, <function>sd_uid_get_state()</function> and
+ <function>sd_uid_get_login_time()</function> returns 0 or a positive
+ integer. If the test succeeds, <function>sd_uid_is_on_seat()</function>
+ returns a positive integer; if it fails, 0. <function>sd_uid_get_sessions()</function>
+ and <function>sd_uid_get_seats()</function> return the number of entries
+ in the returned arrays. <function>sd_uid_get_display()</function>
+ returns a non-negative code on success. On failure, these calls return
+ a negative errno-style error code.</para>
<refsect2>
<title>Errors</title>