SystemConfiguration.fproj/SCPreferencesPrivate.h

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