journal: don't export MESSAGE_ID() macro

[elogind.git] / src / systemd / sd-login.h

diff --git a/src/systemd/sd-login.h b/src/systemd/sd-login.h
index f8c3c6913a04cff173a2c4408804046b21701e69..6bd1f2da4a77203f66f8cf8495dec9b4cdbfb161 100644 (file)
--- a/src/systemd/sd-login.h
+++ b/src/systemd/sd-login.h
@@ -34,7 +34,9 @@ extern "C" {
  * Instead of returning an empty string array or empty uid array, we
  * may return NULL.
  *
  * Instead of returning an empty string array or empty uid array, we
  * may return NULL.
  *

- * Free the data we return with libc free().
+ * Free the data the library returns with libc free(). String arrays
+ * are NULL terminated and you need to free the array itself in
+ * addition to the strings contained.

  *
  * We return error codes as negative errno, kernel-style. 0 or
  * positive on success.
  *
  * We return error codes as negative errno, kernel-style. 0 or
  * positive on success.


@@ -42,6 +44,8 @@ extern "C" {
  * These functions access data in /proc, /sys/fs/cgroup and /run. All
  * of these are virtual file systems, hence the accesses are
  * relatively cheap.
  * These functions access data in /proc, /sys/fs/cgroup and /run. All
  * of these are virtual file systems, hence the accesses are
  * relatively cheap.

+ *
+ * See sd-login(3) for more information.

  */
 
 /* Get session from PID. Note that 'shared' processes of a user are
  */
 
 /* Get session from PID. Note that 'shared' processes of a user are


@@ -61,7 +65,7 @@ int sd_pid_get_owner_uid(pid_t pid, uid_t *uid);
  * error for non-service processes. */
 int sd_pid_get_unit(pid_t, char **unit);
 
  * error for non-service processes. */
 int sd_pid_get_unit(pid_t, char **unit);
 

-/* Get state from uid. Possible states: offline, lingering, online, active */
+/* Get state from uid. Possible states: offline, lingering, online, active, closing */

 int sd_uid_get_state(uid_t uid, char**state);
 
 /* Return 1 if uid has session on seat. If require_active is true will
 int sd_uid_get_state(uid_t uid, char**state);
 
 /* Return 1 if uid has session on seat. If require_active is true will


@@ -78,9 +82,14 @@ int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions);
  * just return number of seats.*/
 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
 
  * just return number of seats.*/
 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
 

-/* Return 1 if the session is a active */
+/* Return 1 if the session is a active. */

 int sd_session_is_active(const char *session);
 
 int sd_session_is_active(const char *session);
 

+/* Get state from session. Possible states: online, active, closing
+ * (This function is a more generic version of
+ * sd_session_is_active().) */
+int sd_session_get_state(const char *sessio, char **state);
+

 /* Determine user id of session */
 int sd_session_get_uid(const char *session, uid_t *uid);
 
 /* Determine user id of session */
 int sd_session_get_uid(const char *session, uid_t *uid);
 


@@ -110,6 +119,12 @@ int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsign
 /* Return whether the seat is multi-session capable */
 int sd_seat_can_multi_session(const char *seat);
 
 /* Return whether the seat is multi-session capable */
 int sd_seat_can_multi_session(const char *seat);
 

+/* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */
+int sd_seat_can_tty(const char *seat);
+
+/* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */
+int sd_seat_can_graphical(const char *seat);
+

 /* Get all seats, store in *seats. Returns the number of seats. If
  * seats is NULL only returns number of seats. */
 int sd_get_seats(char ***seats);
 /* Get all seats, store in *seats. Returns the number of seats. If
  * seats is NULL only returns number of seats. */
 int sd_get_seats(char ***seats);