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=30b254c805b6273d3e3406ae0fa7299aebb14545;hp=cc8fc0f5b6046462a6bad549843fa4b0a8cc4b2e;hb=89f7c8465cd1ab37347dd0c15920bce31e8225df;hpb=56ba3c78ae35065064c4289a0c8e22a81256af20 diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index cc8fc0f5b..30b254c80 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -111,7 +111,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 @@ -127,19 +127,19 @@ currently active (> 0), where the user is currently online but possibly inactive (= 0), or logged in at all but possibly closing the session (< 0). The call returns a - NULL terminated string array of session identifiers in + NULL terminated string array of session identifiers in sessions which needs to be freed by the caller with the libc 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 + 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 @@ -152,11 +152,11 @@ 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, @@ -171,9 +171,8 @@ 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 + available as a shared library, which can be compiled and + linked to with the libsystemd-login pkg-config1 file.