SystemConfiguration.fproj/SCPreferencesPathKey.h

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