Other Alias
sd_session_is_active, sd_session_get_state, sd_session_get_uid, sd_session_get_service, sd_session_get_type, sd_session_get_class, sd_session_get_display, sd_session_get_ttySYNOPSIS
#include <systemd/sd-login.h>
-
int sd_session_is_active(const char* session);
- int sd_session_get_state(const char* session, char** state);
- int sd_session_get_uid(const char* session, uid_t* uid);
- int sd_session_get_seat(const char* session, char** seat);
- int sd_session_get_service(const char* session, char** service);
- int sd_session_get_type(const char* session, char** type);
- int sd_session_get_class(const char* session, char** class);
- int sd_session_get_display(const char* session, char** display);
- int sd_session_get_tty(const char* session, char** tty);
- int sd_session_get_state(const char* session, char** state);
DESCRIPTION
sd_session_is_active()
sd_session_get_state() may be used to determine the state of the session identified by the specified session identifier. The following states are currently known: online (session logged in, but session not active, i.e. not in the foreground), active (session logged in and active, i.e. in the foreground), closing (session nominally logged out, but some processes belonging to it are still around). In the future additional states might be defined, client code should be written to be robust in regards to additional state strings being returned. This function is a more generic version of sd_session_is_active(). The returned string needs to be freed with the libc free(3) call after use.
sd_session_get_uid() may be used to determine the user identifier of the Unix user the session identified by the specified session identifier belongs to.
sd_session_get_seat() may be used to determine the seat identifier of the seat the session identified by the specified session identifier belongs to. Note that not all sessions are attached to a seat, this call will fail for them. The returned string needs to be freed with the libc free(3) call after use.
sd_session_get_service() may be used to determine the name of the service (as passed during PAM session setup) that registered the session identified by the specified session identifier. The returned string needs to be freed with the libc free(3) call after use.
sd_session_get_type() may be used to determine the type of the session identified by the specified session identifier. The returned string is one of x11, tty or unspecified and needs to be freed with the libc free(3) call after use.
sd_session_get_class() may be used to determine the class of the session identified by the specified session identifier. The returned string is one of user, greeter, lock-screen, or background and needs to be freed with the libc free(3) call after use.
sd_session_get_display() may be used to determine the X11 display of the session identified by the specified session identifier. The returned string needs to be freed with the libc free(3) call after use.
sd_session_get_tty() may be used to determine the TTY device of the session identified by the specified session identifier. The returned string needs to be freed with the libc free(3) call after use.
If the session parameter of any of these functions is passed as NULL the operation is executed for the session the calling process is a member of, if there is any.
RETURN VALUE
If the test succeeds sd_session_is_active() returns a positive integer, if it fails 0. On success sd_session_get_state(), sd_session_get_uid(), sd_session_get_seat(), sd_session_get_service(), sd_session_get_type(), sd_session_get_class(), sd_session_get_display() and sd_session_get_tty() return 0 or a positive integer. On failure, these calls return a negative errno-style error code.
NOTES
The sd_session_is_active(), sd_session_get_state(), sd_session_get_uid(), sd_session_get_seat(), sd_session_get_service(), sd_session_get_type(), sd_session_get_class(), sd_session_get_display() and sd_session_get_tty() interfaces are available as shared library, which can be compiled and linked to with the libsystemd-login pkg-config(1) file.