SystemConfiguration.fproj/SCDynamicStoreKey.h

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