Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 3.87 KB

nf-dhcpsapi-dhcpenumclasses.md

File metadata and controls

128 lines (96 loc) · 3.87 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.DhcpEnumClasses
DhcpEnumClasses function (dhcpsapi.h)
Enumerates the user or vendor classes configured for the DHCP server.
DhcpEnumClasses
DhcpEnumClasses function [DHCP]
dhcp.dhcpenumclasses
dhcpsapi/DhcpEnumClasses
dhcp\dhcpenumclasses.htm
DHCP
93f37424-1a81-477e-85da-359885e94349
12/05/2018
DhcpEnumClasses, DhcpEnumClasses function [DHCP], dhcp.dhcpenumclasses, dhcpsapi/DhcpEnumClasses
dhcpsapi.h
Windows
None supported
Windows Server 2008 R2 [desktop apps only]
Dhcpsapi.lib
Dhcpsapi.dll
Windows
19H1
DhcpEnumClasses
dhcpsapi/DhcpEnumClasses
c++
APIRef
kbSyntax
DllExport
Dhcpsapi.dll
DhcpEnumClasses

DhcpEnumClasses function

-description

The DhcpEnumClasses function enumerates the user or vendor classes configured for the DHCP server.

-parameters

-param ServerIpAddress [in]

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

-param ReservedMustBeZero [in]

Reserved. This field must be set to zero.

-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 100 classes, and 200 classes are stored on the server, the resume handle can be used after the first 100 classes are retrieved to obtain the next 100 on a subsequent call, and so forth.

-param PreferredMaximum [in]

Specifies the preferred maximum number of classes to return. If the number of remaining unenumerated classes is less than this value, then that amount will be returned. To retrieve all classes available on the DHCP server, set this parameter to 0xFFFFFFFF.

-param ClassInfoArray [out]

Pointer to a DHCP_CLASS_INFO_ARRAY structure that contains the returned classes. If there are no classes available on the DHCP server, this parameter will return null.

-param nRead [out]

Pointer to a DWORD value that specifies the number of classes returned in ClassInfoArray.

-param nTotal [out]

Pointer to a DWORD value that specifies the total number of classes stored 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_JET_ERROR
 An error occurred while accessing the DHCP server's database.

-see-also

DHCP_CLASS_INFO_ARRAY

DhcpCreateClass

DhcpDeleteClass