SystemConfiguration.fproj/SCDynamicStoreCopyDHCPInfo.h

   1 /*
   2  * Copyright (c) 2001, 2002, 2004, 2005, 2008 Apple 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 _SCDYNAMICSTORECOPYDHCPINFO_H
  25 #ifdef  USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS
  26 #include <SystemConfiguration/_SCDynamicStoreCopyDHCPInfo.h>
  27 #else   /* USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS */
  28 #define _SCDYNAMICSTORECOPYDHCPINFO_H
  29
  30 #include <Availability.h>
  31 #include <sys/cdefs.h>
  32 #include <CoreFoundation/CoreFoundation.h>
  33 #include <SystemConfiguration/SCDynamicStore.h>
  34
  35
  36 /*!
  37         @header SCDynamicStoreCopyDHCPInfo
  38         @discussion The functions of the SCDynamicStoreCopyDHCPInfo API
  39                 provide access to information returned by the DHCP or
  40                 BOOTP server.
  41  */
  42
  43
  44 __BEGIN_DECLS
  45
  46 /*!
  47         @function SCDynamicStoreCopyDHCPInfo
  48         @discussion Copies the DHCP information for the requested serviceID,
  49                 or the primary service if serviceID == NULL.
  50         @param store An SCDynamicStoreRef representing the dynamic store session
  51                 that should be used for communication with the server.
  52                 If NULL, a temporary session will be used.
  53         @param serviceID A CFStringRef containing the requested service.
  54                 If NULL, returns information for the primary service.
  55         @result Returns a dictionary containing DHCP information if successful;
  56                 NULL otherwise.
  57                 Use the DHCPInfoGetOption function to retrieve
  58                 individual options from the returned dictionary.
  59
  60                 A non-NULL return value must be released using CFRelease().
  61  */
  62 CFDictionaryRef
  63 SCDynamicStoreCopyDHCPInfo      (SCDynamicStoreRef      store,
  64                                  CFStringRef            serviceID)      __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  65
  66 /*!
  67         @function DHCPInfoGetOptionData
  68         @discussion Returns a non-NULL CFDataRef containing the DHCP
  69                 option data, if present.
  70         @param info The non-NULL DHCP information dictionary returned by
  71                 calling SCDynamicStoreCopyDHCPInfo.
  72         @param code The DHCP option code (see RFC 2132) to return
  73                 data for.
  74         @result Returns a non-NULL CFDataRef containing the option data;
  75                 NULL if the requested option data is not present.
  76
  77                 The return value must NOT be released.
  78  */
  79 CFDataRef
  80 DHCPInfoGetOptionData           (CFDictionaryRef        info,
  81                                  UInt8                  code)           __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  82
  83 /*!
  84         @function DHCPInfoGetLeaseStartTime
  85         @discussion Returns a CFDateRef corresponding to the lease start time,
  86                 if present.
  87         @param info The non-NULL DHCP information dictionary returned by
  88                 calling SCDynamicStoreCopyDHCPInfo.
  89         @result Returns a non-NULL CFDateRef if lease start time information is
  90                 present; NULL if the information is not present or if the
  91                 configuration method is not DHCP.
  92
  93                 The return value must NOT be released.
  94  */
  95 CFDateRef
  96 DHCPInfoGetLeaseStartTime       (CFDictionaryRef        info)           __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  97
  98 __END_DECLS
  99
 100 #endif  /* USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS */
 101 #endif  /* _SCDYNAMICSTORECOPYDHCPINFO_H */