SystemConfiguration.fproj/SCDynamicStoreKey.h

   1 /*
   2  * Copyright (c) 2000-2002 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 _SCDYNAMICSTOREKEY_H
  25 #define _SCDYNAMICSTOREKEY_H
  26
  27 #include <sys/cdefs.h>
  28 #include <CoreFoundation/CoreFoundation.h>
  29
  30
  31 /*!
  32         @header SCDynamicStoreKey
  33  */
  34
  35
  36 __BEGIN_DECLS
  37
  38 /*
  39  * SCDynamicStoreKeyCreate*
  40  * - convenience routines that create a CFString key for an item in the store
  41  */
  42
  43 /*!
  44         @function SCDynamicStoreKeyCreate
  45         @discussion Creates a store key using the given format.
  46  */
  47 CFStringRef
  48 SCDynamicStoreKeyCreate                         (
  49                                                 CFAllocatorRef  allocator,
  50                                                 CFStringRef     fmt,
  51                                                 ...
  52                                                 );
  53
  54 /*!
  55         @function SCDynamicStoreKeyCreateNetworkGlobalEntity
  56  */
  57 CFStringRef
  58 SCDynamicStoreKeyCreateNetworkGlobalEntity      (
  59                                                 CFAllocatorRef  allocator,
  60                                                 CFStringRef     domain,
  61                                                 CFStringRef     entity
  62                                                 );
  63
  64 /*!
  65         @function SCDynamicStoreKeyCreateNetworkInterface
  66  */
  67 CFStringRef
  68 SCDynamicStoreKeyCreateNetworkInterface         (
  69                                                 CFAllocatorRef  allocator,
  70                                                 CFStringRef     domain
  71                                                 );
  72
  73 /*!
  74         @function SCDynamicStoreKeyCreateNetworkInterfaceEntity
  75  */
  76 CFStringRef
  77 SCDynamicStoreKeyCreateNetworkInterfaceEntity   (
  78                                                 CFAllocatorRef  allocator,
  79                                                 CFStringRef     domain,
  80                                                 CFStringRef     ifname,
  81                                                 CFStringRef     entity
  82                                                 );
  83
  84 /*!
  85         @function SCDynamicStoreKeyCreateNetworkServiceEntity
  86  */
  87 CFStringRef
  88 SCDynamicStoreKeyCreateNetworkServiceEntity     (
  89                                                 CFAllocatorRef  allocator,
  90                                                 CFStringRef     domain,
  91                                                 CFStringRef     serviceID,
  92                                                 CFStringRef     entity
  93                                                 );
  94
  95 /*!
  96         @function SCDynamicStoreKeyCreateComputerName
  97         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
  98                 function to receive notifications when the current
  99                 computer/host name changes.
 100         @result A notification string for the current computer/host name.
 101 */
 102 CFStringRef
 103 SCDynamicStoreKeyCreateComputerName             (
 104                                                 CFAllocatorRef          allocator
 105                                                 );
 106
 107 /*!
 108         @function SCDynamicStoreKeyCreateConsoleUser
 109         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
 110                 function to receive notifications when the current "Console"
 111                 user changes.
 112         @result A notification string for the current "Console" user.
 113 */
 114 CFStringRef
 115 SCDynamicStoreKeyCreateConsoleUser              (
 116                                                 CFAllocatorRef          allocator
 117                                                 );
 118
 119 /*!
 120         @function SCDynamicStoreKeyCreateHostNames
 121         @discussion Creates a key that can be used in conjunction with
 122                 SCDynamicStoreSetNotificationKeys() to receive
 123                 notifications when the HostNames entity changes.  The
 124                 HostNames entity contains the LocalHostName.
 125         @result A notification string for the HostNames entity.
 126 */
 127 CFStringRef
 128 SCDynamicStoreKeyCreateHostNames                (
 129                                                 CFAllocatorRef          allocator
 130                                                 );
 131
 132 /*!
 133         @function SCDynamicStoreKeyCreateLocation
 134         @discussion Creates a key that can be used in conjunction with
 135                 SCDynamicStoreSetNotificationKeys() to receive
 136                 notifications when the "location" identifier changes.
 137         @result A notification string for the current "location" identifier.
 138 */
 139 CFStringRef
 140 SCDynamicStoreKeyCreateLocation                 (
 141                                                 CFAllocatorRef          allocator
 142                                                 );
 143
 144 /*!
 145         @function SCDynamicStoreKeyCreateProxies
 146         @discussion Creates a key that can be used by the SCDynamicStoreSetNotificationKeys()
 147                 function to receive notifications when the current network proxy
 148                 settings (HTTP, FTP, ...) are changed.
 149         @result A notification string for the current proxy settings.
 150 */
 151 CFStringRef
 152 SCDynamicStoreKeyCreateProxies                  (
 153                                                 CFAllocatorRef          allocator
 154                                                 );
 155
 156 __END_DECLS
 157
 158 #endif /* _SCDYNAMICSTOREKEY_H */