You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
4.2 KiB
119 lines
4.2 KiB
/* |
|
* Copyright (c) 2001, 2002, 2004, 2005, 2008, 2012, 2015 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 _SCDYNAMICSTORECOPYDHCPINFO_H |
|
#define _SCDYNAMICSTORECOPYDHCPINFO_H |
|
|
|
#include <Availability.h> |
|
#include <sys/cdefs.h> |
|
#include <CoreFoundation/CoreFoundation.h> |
|
#include <SystemConfiguration/SCDynamicStore.h> |
|
|
|
CF_IMPLICIT_BRIDGING_ENABLED |
|
CF_ASSUME_NONNULL_BEGIN |
|
|
|
/*! |
|
@header SCDynamicStoreCopyDHCPInfo |
|
@discussion The functions of the SCDynamicStoreCopyDHCPInfo API |
|
provide access to information returned by the DHCP or |
|
BOOTP server. |
|
*/ |
|
|
|
|
|
__BEGIN_DECLS |
|
|
|
/*! |
|
@function SCDynamicStoreCopyDHCPInfo |
|
@discussion Copies the DHCP information for the requested serviceID, |
|
or the primary service if serviceID == NULL. |
|
@param store An SCDynamicStoreRef representing the dynamic store session |
|
that should be used for communication with the server. |
|
If NULL, a temporary session will be used. |
|
@param serviceID A CFStringRef containing the requested service. |
|
If NULL, returns information for the primary service. |
|
@result Returns a dictionary containing DHCP information if successful; |
|
NULL otherwise. |
|
Use the DHCPInfoGetOption function to retrieve |
|
individual options from the returned dictionary. |
|
|
|
A non-NULL return value must be released using CFRelease(). |
|
*/ |
|
CFDictionaryRef __nullable |
|
SCDynamicStoreCopyDHCPInfo (SCDynamicStoreRef __nullable store, |
|
CFStringRef __nullable serviceID) __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_NA); |
|
|
|
/*! |
|
@function DHCPInfoGetOptionData |
|
@discussion Returns a non-NULL CFDataRef containing the DHCP |
|
option data, if present. |
|
@param info The non-NULL DHCP information dictionary returned by |
|
calling SCDynamicStoreCopyDHCPInfo. |
|
@param code The DHCP option code (see RFC 2132) to return |
|
data for. |
|
@result Returns a non-NULL CFDataRef containing the option data; |
|
NULL if the requested option data is not present. |
|
|
|
The return value must NOT be released. |
|
*/ |
|
CFDataRef __nullable |
|
DHCPInfoGetOptionData (CFDictionaryRef info, |
|
UInt8 code) __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_NA); |
|
|
|
/*! |
|
@function DHCPInfoGetLeaseStartTime |
|
@discussion Returns a CFDateRef corresponding to the lease start time, |
|
if present. |
|
@param info The non-NULL DHCP information dictionary returned by |
|
calling SCDynamicStoreCopyDHCPInfo. |
|
@result Returns a non-NULL CFDateRef if lease start time information is |
|
present; NULL if the information is not present or if the |
|
configuration method is not DHCP. |
|
|
|
The return value must NOT be released. |
|
*/ |
|
CFDateRef __nullable |
|
DHCPInfoGetLeaseStartTime (CFDictionaryRef info) __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_NA); |
|
|
|
|
|
/*! |
|
@function DHCPInfoGetLeaseExpirationTime |
|
@discussion Returns a CFDateRef corresponding to the lease expiration time, |
|
if present. |
|
@param info The non-NULL DHCP information dictionary returned by |
|
calling SCDynamicStoreCopyDHCPInfo. |
|
@result Returns a non-NULL CFDateRef if the DHCP lease has an expiration; |
|
NULL if the lease is infinite i.e. has no expiration, or the |
|
configuration method is not DHCP. An infinite lease can be determined |
|
by a non-NULL lease start time (see DHCPInfoGetLeaseStartTime above). |
|
|
|
The return value must NOT be released. |
|
*/ |
|
CFDateRef __nullable |
|
DHCPInfoGetLeaseExpirationTime (CFDictionaryRef info) __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_NA); |
|
|
|
__END_DECLS |
|
|
|
CF_ASSUME_NONNULL_END |
|
CF_IMPLICIT_BRIDGING_DISABLED |
|
|
|
#endif /* _SCDYNAMICSTORECOPYDHCPINFO_H */
|
|
|