SystemConfiguration.fproj/SCDynamicStoreCopySpecificPrivate.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25
  26 #ifndef _SCDYNAMICSTORECOPYSPECIFICPRIVATE_H
  27 #define _SCDYNAMICSTORECOPYSPECIFICPRIVATE_H
  28
  29 #include <sys/cdefs.h>
  30 #include <CoreFoundation/CoreFoundation.h>
  31 #include <SystemConfiguration/SCDynamicStore.h>
  32
  33
  34 /*!
  35         @header SCDynamicStoreCopySpecificPrivate.h
  36         The following APIs allow an application to retrieve console
  37         information.
  38  */
  39
  40
  41 __BEGIN_DECLS
  42
  43 /*
  44  * Predefined keys for the console session dictionaries
  45  */
  46 extern const CFStringRef kSCConsoleSessionID;           /* value is CFNumber */
  47 extern const CFStringRef kSCConsoleSessionUserName;     /* value is CFString */
  48 extern const CFStringRef kSCConsoleSessionUID;          /* value is CFNumber */
  49 extern const CFStringRef kSCConsoleSessionConsoleSet;   /* value is CFNumber */
  50 extern const CFStringRef kSCConsoleSessionOnConsole;    /* value is CFBoolean */
  51
  52 /*!
  53         @function SCDynamicStoreCopyConsoleInformation
  54         @discussion Returns information about all console sessions on the system.
  55         @param store An SCDynamicStoreRef that should be used for communication
  56                 with the server.
  57                 If NULL, a temporary session will be used.
  58         @result An array of dictionaries containing information about each
  59                 console session on the system; NULL if no sessions are defined
  60                 or if an error was encountered.
  61
  62                 The contents of the returned array match that of the CoreGraphics
  63                 CGSCopySessionList() SPI.
  64
  65                 You must release the returned value.
  66  */
  67 CFArrayRef
  68 SCDynamicStoreCopyConsoleInformation    (
  69                                         SCDynamicStoreRef       store
  70                                         );
  71
  72
  73 __END_DECLS
  74
  75 #endif /* _SCDYNAMICSTORECOPYSPECIFICPRIVATE_H */