DhcpEnumOptionsV5 function

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,
  _Inout_ DHCP_RESUME_HANDLE  *ResumeHandle,
  _In_    DWORD               PreferredMaximum,
  _Out_   LPDHCP_OPTION_ARRAY *Options,
  _Out_   DWORD               *OptionsRead,
  _Out_   DWORD               *OptionsTotal
);

Parameters

ServerIpAddress [in]

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

Flags [in]

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

ValueMeaning
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.

 

ClassName [in]

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

VendorName [in]

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.

ResumeHandle [in, out]

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.

PreferredMaximum [in]

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.

Options [out]

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.

OptionsRead [out]

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

OptionsTotal [out]

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 codeDescription
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpCreateOptionV5
DhcpRemoveOptionV5
DHCP_OPTION_ARRAY

 

 

Show: