SystemConfiguration.fproj/DHCPClientPreferences.h

   1 /*
   2  * Copyright (c) 2001 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25
  26 #ifndef _DHCPCLIENTPREFERENCES_H
  27 #define _DHCPCLIENTPREFERENCES_H
  28
  29 #include <sys/cdefs.h>
  30 #include <CoreFoundation/CFString.h>
  31
  32 /*!
  33         @header DHCPClientPreferences.h
  34  */
  35
  36 __BEGIN_DECLS
  37
  38 /*!
  39         @function DHCPClientPreferencesSetApplicationOptions
  40         @discussion Updates the DHCP client preferences to include the
  41                 given list of options for the given "applicationID".
  42         @param applicationID The application's preference ID, for example:
  43                 "com.apple.SystemPreferences".
  44         @param options An array of 8-bit values containing the
  45                 DHCP option codes (see RFC 2132) for this applicationID.
  46                 A NULL value will clear the list of options for this
  47                 application ID.
  48         @param count The number of elements in "options".
  49         @result TRUE if the operation succeeded, FALSE otherwise.
  50  */
  51
  52 Boolean
  53 DHCPClientPreferencesSetApplicationOptions(CFStringRef applicationID,
  54                                            UInt8 * options,
  55                                            CFIndex count);
  56
  57 /*!
  58         @function DHCPClientPreferencesCopyApplicationOptions
  59         @discussion Copies the requested DHCP options for the
  60                 given "applicationID".
  61         @param applicationID The application's preference ID, for example
  62                 "com.apple.SystemPreferences".
  63         @param count The number of elements in the returned array.
  64         @result The list of options for the given "applicationID", or
  65                 NULL if no options are defined or an error occurred.
  66
  67                 When done, use free() to release a non-NULL return value.
  68  */
  69
  70 UInt8 *
  71 DHCPClientPreferencesCopyApplicationOptions(CFStringRef applicationID,
  72                                             CFIndex * count);
  73
  74 __END_DECLS
  75
  76 #endif /* _DHCPCLIENTPREFERENCES_H */