SD_SESSION_IS_ACTIVE(3)

NAME
sd_session_is_active, sd_session_get_uid, sd_session_get_seat, sd_session_get_service, sd_session_get_type, sd_session_get_class, sd_session_get_display - Determine state of a specific session

SYNOPSIS

#include <systemd/sd-login.h>

int sd_session_is_active(const char* session);

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);

DESCRIPTION

sd_session_is_active() may be used to determine whether the session identified by the specified session identifier is currently active (i.e. currently in the foreground and available for user input) or not.

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 or lock-screen 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 is one of 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_uid(), sd_session_get_service() and sd_session_get_seat() 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_uid(), sd_session_get_service() and sd_session_get_seat() interfaces are available as shared library, which can be compiled and linked to with the libsystemd-login pkg-config(1) file.

SEE ALSO

systemd(1), sd-login(7), sd_pid_get_session(3)

AUTHOR

Lennart Poettering <lennart@poettering.net>
    Developer