SystemConfiguration.fproj/SCPreferencesPathKey.h

   1 /*
   2  * Copyright (c) 2001-2004 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 _SCPREFERENCESPATHKEY_H
  25 #define _SCPREFERENCESPATHKEY_H
  26
  27 #include <sys/cdefs.h>
  28 #include <AvailabilityMacros.h>
  29 #include <CoreFoundation/CoreFoundation.h>
  30
  31
  32 /*!
  33         @header SCPreferencesPathKey
  34  */
  35
  36
  37 __BEGIN_DECLS
  38
  39 /*
  40  * SCPreferencesPathKeyCreate*
  41  * - convenience routines that create a CFString key for an item in the store
  42  */
  43
  44 /*!
  45         @function SCPreferencesPathKeyCreate
  46         @discussion Creates a preferences path key using the given format.
  47  */
  48 CFStringRef
  49 SCPreferencesPathKeyCreate                      (
  50                                                 CFAllocatorRef  allocator,
  51                                                 CFStringRef     fmt,
  52                                                 ...
  53                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
  54
  55 /*!
  56         @function SCPreferencesPathKeyCreateNetworkServices
  57  */
  58 CFStringRef
  59 SCPreferencesPathKeyCreateNetworkServices       (
  60                                                 CFAllocatorRef  allocator
  61                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
  62
  63 /*!
  64         @function SCPreferencesPathKeyCreateNetworkServiceEntity
  65  */
  66 CFStringRef
  67 SCPreferencesPathKeyCreateNetworkServiceEntity  (
  68                                                 CFAllocatorRef  allocator,
  69                                                 CFStringRef     service,
  70                                                 CFStringRef     entity
  71                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
  72
  73 /*!
  74         @function SCPreferencesPathKeyCreateSets
  75  */
  76 CFStringRef
  77 SCPreferencesPathKeyCreateSets                  (
  78                                                 CFAllocatorRef  allocator
  79                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
  80
  81 /*!
  82         @function SCPreferencesPathKeyCreateSet
  83  */
  84 CFStringRef
  85 SCPreferencesPathKeyCreateSet                   (
  86                                                 CFAllocatorRef  allocator,
  87                                                 CFStringRef     set
  88                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
  89
  90 /*!
  91         @function SCPreferencesPathKeyCreateSetNetworkInterfaceEntity
  92  */
  93 CFStringRef
  94 SCPreferencesPathKeyCreateSetNetworkInterfaceEntity(
  95                                                    CFAllocatorRef       allocator,
  96                                                    CFStringRef  set,
  97                                                    CFStringRef  ifname,
  98                                                    CFStringRef  entity
  99                                                    )                            AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
 100
 101 /*!
 102         @function SCPreferencesPathKeyCreateSetNetworkGlobalEntity
 103  */
 104 CFStringRef
 105 SCPreferencesPathKeyCreateSetNetworkGlobalEntity(
 106                                                 CFAllocatorRef  allocator,
 107                                                 CFStringRef     set,
 108                                                 CFStringRef     entity
 109                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
 110
 111 /*!
 112         @function SCPreferencesPathKeyCreateSetNetworkService
 113  */
 114 CFStringRef
 115 SCPreferencesPathKeyCreateSetNetworkService     (
 116                                                 CFAllocatorRef  allocator,
 117                                                 CFStringRef     set,
 118                                                 CFStringRef     service
 119                                                 )                               AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
 120
 121 /*!
 122         @function SCPreferencesPathKeyCreateSetNetworkServiceEntity
 123  */
 124 CFStringRef
 125 SCPreferencesPathKeyCreateSetNetworkServiceEntity(
 126                                                  CFAllocatorRef allocator,
 127                                                  CFStringRef    set,
 128                                                  CFStringRef    service,
 129                                                  CFStringRef    entity
 130                                                  )                              AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
 131
 132 __END_DECLS
 133
 134 #endif /* _SCPREFERENCESPATHKEY_H */