SystemConfiguration.fproj/SCDynamicStoreCopyDHCPInfo.h

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