SystemConfiguration.fproj/SCPreferencesPrivate.h

   1 /*
   2  * Copyright (c) 2000-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 _SCPREFERENCESPRIVATE_H
  25 #define _SCPREFERENCESPRIVATE_H
  26
  27 #include <CoreFoundation/CoreFoundation.h>
  28 #include <SystemConfiguration/SCPreferences.h>
  29
  30
  31 /*!
  32         @enum SCPreferencesKeyType
  33         @discussion Used with the SCDynamicStoreKeyCreatePreferences() function
  34                 to describe the resulting CFStringRef argument.
  35         @constant kSCPreferencesKeyLock Key used when exclusive access to the
  36                 stored preferences is obtained or released.
  37         @constant kSCPreferencesKeyCommit Key used when new preferences are
  38                 committed to the store
  39         @constant kSCPreferencesKeyApply Key used when new preferences are
  40                 to be applied to the active system configuration.
  41  */
  42 enum {
  43         kSCPreferencesKeyLock   = 1,
  44         kSCPreferencesKeyCommit = 2,
  45         kSCPreferencesKeyApply  = 3
  46 };
  47 typedef int32_t SCPreferencesKeyType;
  48
  49 __BEGIN_DECLS
  50
  51 /*!
  52         @function SCDynamicStoreKeyCreatePreferences
  53         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
  54                 function to receive notifications of changes to the saved
  55                 preferences.
  56         @param allocator ...
  57         @param prefsID A string that identifies the name of the
  58                 group of preferences to be accessed/updated.
  59         @param keyType A kSCPreferencesKeyType indicating the type a notification
  60                 key to be returned.
  61         @result A notification string for the specified preference identifier.
  62  */
  63 CFStringRef
  64 SCDynamicStoreKeyCreatePreferences      (
  65                                         CFAllocatorRef          allocator,
  66                                         CFStringRef             prefsID,
  67                                         SCPreferencesKeyType    keyType
  68                                         );
  69
  70 SCPreferencesRef
  71 SCUserPreferencesCreate                 (
  72                                         CFAllocatorRef          allocator,
  73                                         CFStringRef             name,
  74                                         CFStringRef             prefsID,
  75                                         CFStringRef             user
  76                                         );
  77
  78 CFStringRef
  79 SCDynamicStoreKeyCreateUserPreferences  (
  80                                         CFAllocatorRef          allocator,
  81                                         CFStringRef             prefsID,
  82                                         CFStringRef             user,
  83                                         SCPreferencesKeyType    keyType
  84                                         );
  85
  86 __END_DECLS
  87
  88 #endif /* _SCPREFERENCESPRIVATE_H */