SystemConfiguration.fproj/SCDynamicStoreKey.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22
  23 #ifndef _SCDYNAMICSTOREKEY_H
  24 #define _SCDYNAMICSTOREKEY_H
  25
  26 #include <sys/cdefs.h>
  27 #include <CoreFoundation/CoreFoundation.h>
  28
  29
  30 /*!
  31         @header SCDynamicStoreKey
  32  */
  33
  34
  35 __BEGIN_DECLS
  36
  37 /*
  38  * SCDynamicStoreKeyCreate*
  39  * - convenience routines that create a CFString key for an item in the store
  40  */
  41
  42 /*!
  43         @function SCDynamicStoreKeyCreate
  44         @discussion Creates a store key using the given format.
  45  */
  46 CFStringRef
  47 SCDynamicStoreKeyCreate                         (
  48                                                 CFAllocatorRef  allocator,
  49                                                 CFStringRef     fmt,
  50                                                 ...
  51                                                 );
  52
  53 /*!
  54         @function SCDynamicStoreKeyCreateNetworkGlobalEntity
  55  */
  56 CFStringRef
  57 SCDynamicStoreKeyCreateNetworkGlobalEntity      (
  58                                                 CFAllocatorRef  allocator,
  59                                                 CFStringRef     domain,
  60                                                 CFStringRef     entity
  61                                                 );
  62
  63 /*!
  64         @function SCDynamicStoreKeyCreateNetworkInterface
  65  */
  66 CFStringRef
  67 SCDynamicStoreKeyCreateNetworkInterface         (
  68                                                 CFAllocatorRef  allocator,
  69                                                 CFStringRef     domain
  70                                                 );
  71
  72 /*!
  73         @function SCDynamicStoreKeyCreateNetworkInterfaceEntity
  74  */
  75 CFStringRef
  76 SCDynamicStoreKeyCreateNetworkInterfaceEntity   (
  77                                                 CFAllocatorRef  allocator,
  78                                                 CFStringRef     domain,
  79                                                 CFStringRef     ifname,
  80                                                 CFStringRef     entity
  81                                                 );
  82
  83 /*!
  84         @function SCDynamicStoreKeyCreateNetworkServiceEntity
  85  */
  86 CFStringRef
  87 SCDynamicStoreKeyCreateNetworkServiceEntity     (
  88                                                 CFAllocatorRef  allocator,
  89                                                 CFStringRef     domain,
  90                                                 CFStringRef     serviceID,
  91                                                 CFStringRef     entity
  92                                                 );
  93
  94 /*!
  95         @function SCDynamicStoreKeyCreateComputerName
  96         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
  97                 function to receive notifications when the current
  98                 computer/host name changes.
  99         @result A notification string for the current computer/host name.
 100 */
 101 CFStringRef
 102 SCDynamicStoreKeyCreateComputerName             (
 103                                                 CFAllocatorRef          allocator
 104                                                 );
 105
 106 /*!
 107         @function SCDynamicStoreKeyCreateConsoleUser
 108         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
 109                 function to receive notifications when the current "Console"
 110                 user changes.
 111         @result A notification string for the current "Console" user.
 112 */
 113 CFStringRef
 114 SCDynamicStoreKeyCreateConsoleUser              (
 115                                                 CFAllocatorRef          allocator
 116                                                 );
 117
 118 /*!
 119         @function SCDynamicStoreKeyCreateHostNames
 120         @discussion Creates a key that can be used in conjunction with
 121                 SCDynamicStoreSetNotificationKeys() to receive
 122                 notifications when the HostNames entity changes.  The
 123                 HostNames entity contains the LocalHostName.
 124         @result A notification string for the HostNames entity.
 125 */
 126 CFStringRef
 127 SCDynamicStoreKeyCreateHostNames                (
 128                                                 CFAllocatorRef          allocator
 129                                                 );
 130
 131 /*!
 132         @function SCDynamicStoreKeyCreateLocation
 133         @discussion Creates a key that can be used in conjunction with
 134                 SCDynamicStoreSetNotificationKeys() to receive
 135                 notifications when the "location" identifier changes.
 136         @result A notification string for the current "location" identifier.
 137 */
 138 CFStringRef
 139 SCDynamicStoreKeyCreateLocation                 (
 140                                                 CFAllocatorRef          allocator
 141                                                 );
 142
 143 /*!
 144         @function SCDynamicStoreKeyCreateProxies
 145         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
 146                 function to receive notifications when the current network proxy
 147                 settings (HTTP, FTP, ...) are changed.
 148         @result A notification string for the current proxy settings.
 149 */
 150 CFStringRef
 151 SCDynamicStoreKeyCreateProxies                  (
 152                                                 CFAllocatorRef          allocator
 153                                                 );
 154
 155 __END_DECLS
 156
 157 #endif /* _SCDYNAMICSTOREKEY_H */