Something went wrong. Try again.
Cider Isn't Darwin Emulation, Really
Something went wrong. Try again.
11 kB · 267 lines
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268/* * Copyright (c) 2000-2002, 2004, 2005, 2008, 2015, 2018 Apple Inc. All rights reserved. * * @APPLE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this * file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_LICENSE_HEADER_END@ */
#ifndef _SCDYNAMICSTOREKEY_H#define _SCDYNAMICSTOREKEY_H
#include <os/availability.h>#include <sys/cdefs.h>#include <CoreFoundation/CoreFoundation.h>
CF_IMPLICIT_BRIDGING_ENABLEDCF_ASSUME_NONNULL_BEGIN
/*! @header SCDynamicStoreKey @discussion The SCDynamicStoreKey API provides convenience functions that an application can use to create a correctly formatted dynamic store key for accessing specific items in the dynamic store. An application can then use the resulting string in any function that requires a dynamic store key. */
__BEGIN_DECLS
/* * SCDynamicStoreKeyCreate * - convenience routines that create a CFString key for an item in the store */
/*! @function SCDynamicStoreKeyCreate @discussion Creates a dynamic store key using the given format. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param fmt A CFStringRef describing the format for this key. @result Returns a string containing the formatted key. */CFStringRefSCDynamicStoreKeyCreate ( CFAllocatorRef __nullable allocator, CFStringRef fmt, ... ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateNetworkGlobalEntity @discussion Creates a dynamic store key that can be used to access a specific global (as opposed to a per-service or per-interface) network configuration entity. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param domain A string specifying the desired domain, such as the requested configuration (kSCDynamicStoreDomainSetup) or the actual state (kSCDynamicStoreDomainState). @param entity A string containing the specific global entity, such as IPv4 (kSCEntNetIPv4) or DNS (kSCEntNetDNS). @result Returns a string containing the formatted key.
*/CFStringRefSCDynamicStoreKeyCreateNetworkGlobalEntity ( CFAllocatorRef __nullable allocator, CFStringRef domain, CFStringRef entity ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateNetworkInterface @discussion Creates a dynamic store key that can be used to access the network interface configuration information stored in the dynamic store. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param domain A string specifying the desired domain, such as the requested configuration (kSCDynamicStoreDomainSetup) or the actual state (kSCDynamicStoreDomainState). @result Returns a string containing the formatted key.
*/CFStringRefSCDynamicStoreKeyCreateNetworkInterface ( CFAllocatorRef __nullable allocator, CFStringRef domain ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateNetworkInterfaceEntity @discussion Creates a dynamic store key that can be used to access the per-interface network configuration information stored in the dynamic store. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param domain A string specifying the desired domain, such as the requested configuration (kSCDynamicStoreDomainSetup) or the actual state (kSCDynamicStoreDomainState). @param ifname A string containing the interface name or a regular expression pattern. @param entity A string containing the specific global entity, such as IPv4 (kSCEntNetIPv4) or DNS (kSCEntNetDNS). @result Returns a string containing the formatted key.
*/CFStringRefSCDynamicStoreKeyCreateNetworkInterfaceEntity ( CFAllocatorRef __nullable allocator, CFStringRef domain, CFStringRef ifname, CFStringRef __nullable entity ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateNetworkServiceEntity @discussion Creates a dynamic store key that can be used to access the per-service network configuration information stored in the dynamic store. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @param domain A string specifying the desired domain, such as the requested configuration (kSCDynamicStoreDomainSetup) or the actual state (kSCDynamicStoreDomainState). @param serviceID A string containing the service ID or a regular expression pattern. @param entity A string containing the specific global entity, such as IPv4 (kSCEntNetIPv4) or DNS (kSCEntNetDNS). @result Returns a string containing the formatted key.
*/CFStringRefSCDynamicStoreKeyCreateNetworkServiceEntity ( CFAllocatorRef __nullable allocator, CFStringRef domain, CFStringRef serviceID, CFStringRef __nullable entity ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateComputerName @discussion Creates a key that can be used in conjuntion with SCDynamicStoreSetNotificationKeys function to receive notifications when the current computer name changes. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @result Returns a notification string for the current computer or host name.*/CFStringRefSCDynamicStoreKeyCreateComputerName ( CFAllocatorRef __nullable allocator ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateConsoleUser @discussion Creates a key that can be used in conjunction with SCDynamicStoreSetNotificationKeys function to receive notifications when the current console user changes. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @result Returns a notification string for the current console user.*/CFStringRefSCDynamicStoreKeyCreateConsoleUser ( CFAllocatorRef __nullable allocator ) API_AVAILABLE(macos(10.1)) API_UNAVAILABLE(ios, tvos, watchos, bridgeos);
/*! @function SCDynamicStoreKeyCreateHostNames @discussion Creates a key that can be used in conjunction with the SCDynamicStoreSetNotificationKeys function to receive notifications when the HostNames entity changes. The HostNames entity includes the local host name. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @result Returns a notification string for the HostNames entity.*/CFStringRefSCDynamicStoreKeyCreateHostNames ( CFAllocatorRef __nullable allocator ) API_AVAILABLE(macos(10.2)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateLocation @discussion Creates a key that can be used in conjunction with the SCDynamicStoreSetNotificationKeys function to receive notifications when the location identifier changes. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @result Returns a notification string for the current location identifier.*/CFStringRefSCDynamicStoreKeyCreateLocation ( CFAllocatorRef __nullable allocator ) API_AVAILABLE(macos(10.2)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
/*! @function SCDynamicStoreKeyCreateProxies @discussion Creates a key that can be used in conjunction with the SCDynamicStoreSetNotificationKeys function to receive notifications when the current network proxy settings (such as HTTP or FTP) are changed. @param allocator The CFAllocator that should be used to allocate memory for this key. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined. @result Returns a notification string for the current proxy settings.*/CFStringRefSCDynamicStoreKeyCreateProxies ( CFAllocatorRef __nullable allocator ) API_AVAILABLE(macos(10.1)) SPI_AVAILABLE(ios(2.0), tvos(9.0), watchos(1.0), bridgeos(1.0));
__END_DECLS
CF_ASSUME_NONNULL_ENDCF_IMPLICIT_BRIDGING_DISABLED
#endif /* _SCDYNAMICSTOREKEY_H */