Edit

DhcpEnumOptionsV6 function (dhcpsapi.h)

  • Article

The DhcpEnumOptionsV6 function returns an enumerated list of DHCP options for a given class and/or vendor.

Syntax

DWORD DHCP_API_FUNCTION DhcpEnumOptionsV6(
  [in]      LPWSTR              ServerIpAddress,
  [in]      DWORD               Flags,
  [in]      LPWSTR              ClassName,
  [in]      LPWSTR              VendorName,
  [in, out] DHCP_RESUME_HANDLE  *ResumeHandle,
  [in]      DWORD               PreferredMaximum,
  [out]     LPDHCP_OPTION_ARRAY *Options,
  [out]     DWORD               *OptionsRead,
  [out]     DWORD               *OptionsTotal
);

Parameters

[in] ServerIpAddress

Pointer to a Unicode string that specifies the IP address or hostname of the DHCP server.

[in] Flags

Specifies a bit flag that indicates whether or not the option is vendor-specific. If it is not, this parameter should be 0.

Value Meaning
DHCP_FLAGS_OPTION_IS_VENDOR
 This flag should be set if the option is provided by a vendor.

[in] ClassName

Unicode string that contains the name of the class whose options will be enumerated.

[in] VendorName

Unicode string that contains the name of the vendor for the class. This parameter is optional.

[in, out] ResumeHandle

Pointer to a DHCP_RESUME_HANDLE value that identifies the enumeration operation. Initially, this value should be zero, with a successful call returning the handle value used for subsequent enumeration requests. For example, if PreferredMaximum is set to 1000 bytes, and 2000 bytes worth of options are stored on the server, the resume handle can be used after the first 1000 bytes are retrieved to obtain the next 1000 on a subsequent call, and so forth.

[in] PreferredMaximum

Specifies the preferred maximum number of bytes of options to return. If the number of remaining unenumerated options (in bytes) is less than this value, then that amount will be returned.

[out] Options

Pointer to a DHCP_OPTION_ARRAY structure containing the returned options. If there are no options available on the DHCP server, this parameter will return null.

[out] OptionsRead

Pointer to a DWORD value that specifies the number of options returned in Options.

[out] OptionsTotal

Pointer to a DWORD value that specifies the total number of options stored on the DHCP server.

Return value

This function returns ERROR_SUCCESS upon a successful call. Otherwise, it returns one of the DHCP Server Management API Error Codes.

Return code Description
ERROR_INVALID_PARAMETER
 The parameters were invalid.
ERROR_NO_MORE_ITEMS
 No more items to enumerate.
ERROR_NOT_ENOUGH_MEMORY
 Memory failure.
ERROR_MORE_DATA
 More data is available to enumerate.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll