SystemConfiguration.fproj/SCDynamicStoreSetSpecificPrivate.h

   1 /*
   2  * Copyright (c) 2001-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 _SCDYNAMICSTORESETSPECIFICPRIVATE_H
  27 #define _SCDYNAMICSTORESETSPECIFICPRIVATE_H
  28
  29 #include <sys/cdefs.h>
  30 #include <SystemConfiguration/SCDynamicStore.h>
  31
  32
  33 __BEGIN_DECLS
  34
  35 /*!
  36         @function SCDynamicStoreSetConsoleInformation
  37         @discussion Returns information about all console users on the system.
  38         @param store An SCDynamicStoreRef that should be used for communication
  39                 with the server.
  40                 If NULL, a temporary session will be used.
  41         @param user A pointer to a character buffer containing the name of
  42                 the current/primary "Console" session. If NULL, any current
  43                 "Console" session information will be reset.
  44         @param uid The user ID of the current/primary "Console" user.
  45         @param gid The group ID of the current/primary "Console" user.
  46         @param sessions An array of dictionaries containing information about
  47                 each console session on the system; NULL if no sessions are
  48                 defined.
  49
  50                 The contents of this array should match that of the CoreGraphics
  51                 CGSCopySessionList() SPI.
  52
  53         @result A boolean indicating the success (or failure) of the call.
  54  */
  55 Boolean
  56 SCDynamicStoreSetConsoleInformation     (
  57                                         SCDynamicStoreRef       store,
  58                                         const char              *user,
  59                                         uid_t                   uid,
  60                                         gid_t                   gid,
  61                                         CFArrayRef              sessions
  62                                         );
  63
  64 /*!
  65         @function SCDynamicStoreSetConsoleUser
  66         @discussion Sets the name, user ID, and group ID of the currently
  67                 logged in user.
  68         @param store An SCDynamicStoreRef that should be used for communication
  69                 with the server.
  70                 If NULL, a temporary session will be used.
  71         @param user A pointer to a character buffer containing the name of
  72                 the current "Console" user. If NULL, any current "Console"
  73                 user information will be reset.
  74         @param uid The user ID of the current "Console" user.
  75         @param gid The group ID of the current "Console" user.
  76         @result A boolean indicating the success (or failure) of the call.
  77  */
  78 Boolean
  79 SCDynamicStoreSetConsoleUser            (
  80                                         SCDynamicStoreRef       store,
  81                                         const char              *user,
  82                                         uid_t                   uid,
  83                                         gid_t                   gid
  84                                         );
  85
  86 __END_DECLS
  87
  88 #endif /* _SCDYNAMICSTORESETSPECIFICPRIVATE_H */