SystemConfiguration.fproj/DHCPClientPreferences.h

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