First Revision (from Archive)
[~jspiros/WindowBlur.git] / CGSInternal / CGSSession.h
1 /*
2  * Copyright (C) 2007-2008 Alacatia Labs
3  * 
4  * This software is provided 'as-is', without any express or implied
5  * warranty.  In no event will the authors be held liable for any damages
6  * arising from the use of this software.
7  * 
8  * Permission is granted to anyone to use this software for any purpose,
9  * including commercial applications, and to alter it and redistribute it
10  * freely, subject to the following restrictions:
11  * 
12  * 1. The origin of this software must not be misrepresented; you must not
13  *    claim that you wrote the original software. If you use this software
14  *    in a product, an acknowledgment in the product documentation would be
15  *    appreciated but is not required.
16  * 2. Altered source versions must be plainly marked as such, and must not be
17  *    misrepresented as being the original software.
18  * 3. This notice may not be removed or altered from any source distribution.
19  * 
20  * Joe Ranieri joe@alacatia.com
21  *
22  */
23
24 #pragma once
25 #include "CGSInternal.h"
26
27 typedef int CGSSessionID;
28
29 CG_EXTERN_C_BEGIN
30
31 /*! Gets information about the current login session. Keys as of 10.4:
32         kCGSSessionGroupIDKey
33         kCGSSessionOnConsoleKey
34         kCGSSessionIDKey
35         kCGSSessionUserNameKey
36         kCGSessionLoginDoneKey
37         kCGSessionLongUserNameKey
38         kCGSSessionSystemSafeBoot
39         kCGSSessionLoginwindowSafeLogin
40         kCGSSessionConsoleSetKey
41         kCGSSessionUserIDKey
42  */
43 CG_EXTERN CFDictionaryRef CGSCopyCurrentSessionDictionary(void);
44
45 /*! Creates a new "blank" login session. Switches to the LoginWindow. This does NOT check to see if fast user switching is enabled! */
46 CG_EXTERN CGError CGSCreateLoginSession(CGSSessionID *outSession);
47
48 /*! Releases a session. */
49 CG_EXTERN CGError CGSReleaseSession(CGSSessionID session);
50
51 /*! Gets a list of sessions. Each session dictionary is in the format returned by `CGSCopyCurrentSessionDictionary`. */
52 CG_EXTERN CFArrayRef CGSCopySessionList(void);
53
54 CG_EXTERN_C_END