Edit

DhcpEnumOptionsV5 function (dhcpsapi.h)

  • Article

The DhcpEnumOptionsV5 function returns an enumerated list of DHCP options for a given user or vendor class.

Syntax

DWORD DhcpEnumOptionsV5(
  [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

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

[in] Flags

A set of flags that indicate the option definition for enumeration.

Value Meaning
0x00000000
 The option definitions are enumerated for a default vendor class.
DHCP_FLAGS_OPTION_IS_VENDOR
0x00000003
 The option definitions are enumerated for a specific vendor class.

[in] ClassName

Pointer to a Unicode string that contains the name of the class whose options will be enumerated. This parameter is optional.

[in] VendorName

Pointer to a Unicode string that contains the name of the vendor for the class. This parameter is optional. If a vendor class name is not provided, the default vendor class name is used.

[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 of option definitions 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 option definitions (in bytes) is less than this value, all option definitions are returned.

[out] Options

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

[out] OptionsRead

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

[out] OptionsTotal

Pointer to a DWORD value that specifies the total number of unenumerated option definitions 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_ACCESS_DENIED
 This call was performed by a client who is not a member of the "DHCP Administrators" security group.
ERROR_DHCP_CLASS_NOT_FOUND
 The supplied user or vendor class name is either incorrect or unknown.

Requirements

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

See also

DHCP_OPTION_ARRAY

DhcpCreateOptionV5

DhcpRemoveOptionV5