SystemConfiguration.fproj/SCDynamicStoreCopyDHCPInfo.h

   1 /*
   2  * Copyright (c) 2001-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 _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.h
  34         The following APIs allow an application to retrieve DHCP/BOOTP
  35         information, in particular DHCP/BOOTP options.
  36  */
  37
  38
  39 __BEGIN_DECLS
  40
  41 /*!
  42         @function SCDynamicStoreCopyDHCPInfo
  43         @discussion Copies the DHCP/BOOTP information dictionary for the
  44                 requested serviceID, or the primary service if
  45                 serviceID == NULL.
  46         @param store An SCDynamicStoreRef that should be used for communication
  47                 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 A dictionary containing DHCP/BOOTP information if successful,
  52                 NULL otherwise.
  53                 Use the DHCPInfoGetOption() 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 BOOTP/DHCP
  64                 option data if present, NULL otherwise.
  65         @param info The non-NULL DHCP information dictionary returned by
  66                 calling SCDynamicStoreCopyDHCPInfo.
  67         @param code The DHCP/BOOTP option code (see RFC 2132) to return
  68                 data for.
  69         @result A non-NULL CFDataRef containing the option data,
  70                 NULL otherwise.
  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, NULL otherwise.  A NULL return value is returned
  81                 if the configuration method is BOOTP.
  82         @param info The non-NULL DHCP information dictionary returned by
  83                 calling SCDynamicStoreCopyDHCPInfo.
  84         @result A non-NULL CFDateRef if present, NULL otherwise.
  85
  86                 The return value must NOT be released.
  87  */
  88 CFDateRef
  89 DHCPInfoGetLeaseStartTime(CFDictionaryRef info);
  90
  91 __END_DECLS
  92
  93 #endif /* _SCDYNAMICSTORECOPYDHCPINFO_H */