Skip to content

Latest commit

 

History

History
165 lines (126 loc) · 4.86 KB

nf-dhcpsapi-dhcpenumoptionsv5.md

File metadata and controls

165 lines (126 loc) · 4.86 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dhcpsapi.DhcpEnumOptionsV5
DhcpEnumOptionsV5 function (dhcpsapi.h)
The DhcpEnumOptionsV5 function returns an enumerated list of DHCP options for a given user or vendor class.
DHCP_FLAGS_OPTION_IS_VENDOR
DhcpEnumOptionsV5
DhcpEnumOptionsV5 function [DHCP]
dhcp.dhcpenumoptionsv5
dhcpsapi/DhcpEnumOptionsV5
dhcp\dhcpenumoptionsv5.htm
DHCP
9fe14fe7-d207-4a5a-b36c-4a5ab32a6bc3
12/05/2018
DHCP_FLAGS_OPTION_IS_VENDOR, DhcpEnumOptionsV5, DhcpEnumOptionsV5 function [DHCP], dhcp.dhcpenumoptionsv5, dhcpsapi/DhcpEnumOptionsV5
dhcpsapi.h
Windows
None supported
Windows Server 2008 R2 [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpEnumOptionsV5
dhcpsapi/DhcpEnumOptionsV5
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpEnumOptionsV5

DhcpEnumOptionsV5 function

-description

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

-parameters

-param ServerIpAddress [in]

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

-param Flags [in]

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.

-param ClassName [in]

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

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

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

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

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

-param OptionsRead [out]

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

-param OptionsTotal [out]

Pointer to a DWORD value that specifies the total number of unenumerated option definitions on the DHCP server.

-returns

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.

-see-also

DHCP_OPTION_ARRAY

DhcpCreateOptionV5

DhcpRemoveOptionV5