SystemConfiguration.fproj/SCDynamicStoreSetSpecificPrivate.h

   1 /*
   2  * Copyright (c) 2001-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef _SCDYNAMICSTORESETSPECIFICPRIVATE_H
  25 #define _SCDYNAMICSTORESETSPECIFICPRIVATE_H
  26
  27 #include <sys/cdefs.h>
  28 #include <SystemConfiguration/SCDynamicStore.h>
  29
  30
  31 __BEGIN_DECLS
  32
  33 /*!
  34         @function SCDynamicStoreSetConsoleInformation
  35         @discussion Returns information about all console users on the system.
  36         @param store An SCDynamicStoreRef that should be used for communication
  37                 with the server.
  38                 If NULL, a temporary session will be used.
  39         @param user A pointer to a character buffer containing the name of
  40                 the current/primary "Console" session. If NULL, any current
  41                 "Console" session information will be reset.
  42         @param uid The user ID of the current/primary "Console" user.
  43         @param gid The group ID of the current/primary "Console" user.
  44         @param sessions An array of dictionaries containing information about
  45                 each console session on the system; NULL if no sessions are
  46                 defined.
  47
  48                 The contents of this array should match that of the CoreGraphics
  49                 CGSCopySessionList() SPI.
  50
  51         @result A boolean indicating the success (or failure) of the call.
  52  */
  53 Boolean
  54 SCDynamicStoreSetConsoleInformation     (
  55                                         SCDynamicStoreRef       store,
  56                                         const char              *user,
  57                                         uid_t                   uid,
  58                                         gid_t                   gid,
  59                                         CFArrayRef              sessions
  60                                         );
  61
  62 /*!
  63         @function SCDynamicStoreSetConsoleUser
  64         @discussion Sets the name, user ID, and group ID of the currently
  65                 logged in user.
  66         @param store An SCDynamicStoreRef that should be used for communication
  67                 with the server.
  68                 If NULL, a temporary session will be used.
  69         @param user A pointer to a character buffer containing the name of
  70                 the current "Console" user. If NULL, any current "Console"
  71                 user information will be reset.
  72         @param uid The user ID of the current "Console" user.
  73         @param gid The group ID of the current "Console" user.
  74         @result A boolean indicating the success (or failure) of the call.
  75  */
  76 Boolean
  77 SCDynamicStoreSetConsoleUser            (
  78                                         SCDynamicStoreRef       store,
  79                                         const char              *user,
  80                                         uid_t                   uid,
  81                                         gid_t                   gid
  82                                         );
  83
  84 __END_DECLS
  85
  86 #endif /* _SCDYNAMICSTORESETSPECIFICPRIVATE_H */