SystemConfiguration.fproj/DHCPClientPreferences.h

   1 /*
   2  * Copyright (c) 2001 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 _DHCPCLIENTPREFERENCES_H
  25 #define _DHCPCLIENTPREFERENCES_H
  26
  27 #include <sys/cdefs.h>
  28 #include <CoreFoundation/CFString.h>
  29
  30 /*!
  31         @header DHCPClientPreferences.h
  32  */
  33
  34 __BEGIN_DECLS
  35
  36 /*!
  37         @function DHCPClientPreferencesSetApplicationOptions
  38         @discussion Updates the DHCP client preferences to include the
  39                 given list of options for the given "applicationID".
  40         @param applicationID The application's preference ID, for example:
  41                 "com.apple.SystemPreferences".
  42         @param options An array of 8-bit values containing the
  43                 DHCP option codes (see RFC 2132) for this applicationID.
  44                 A NULL value will clear the list of options for this
  45                 application ID.
  46         @param count The number of elements in "options".
  47         @result TRUE if the operation succeeded, FALSE otherwise.
  48  */
  49
  50 Boolean
  51 DHCPClientPreferencesSetApplicationOptions(CFStringRef applicationID,
  52                                            UInt8 * options,
  53                                            CFIndex count);
  54
  55 /*!
  56         @function DHCPClientPreferencesCopyApplicationOptions
  57         @discussion Copies the requested DHCP options for the
  58                 given "applicationID".
  59         @param applicationID The application's preference ID, for example
  60                 "com.apple.SystemPreferences".
  61         @param count The number of elements in the returned array.
  62         @result The list of options for the given "applicationID", or
  63                 NULL if no options are defined or an error occurred.
  64
  65                 When done, use free() to release a non-NULL return value.
  66  */
  67
  68 UInt8 *
  69 DHCPClientPreferencesCopyApplicationOptions(CFStringRef applicationID,
  70                                             CFIndex * count);
  71
  72 __END_DECLS
  73
  74 #endif /* _DHCPCLIENTPREFERENCES_H */