nf-dhcpsapi-dhcpenumsubnetclientsv6.md

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.DhcpEnumSubnetClientsV6	DhcpEnumSubnetClientsV6 function (dhcpsapi.h)	The DhcpEnumSubnetClientsV6 function returns an enumerated list of clients with served IP addresses in the specified subnet.	DhcpEnumSubnetClientsV6 DhcpEnumSubnetClientsV6 function [DHCP] dhcp.dhcpenumsubnetclientsv6 dhcpsapi/DhcpEnumSubnetClientsV6	dhcp\dhcpenumsubnetclientsv6.htm	DHCP	501a9cd4-56ff-4b56-9d08-83cb29932ef7	12/05/2018	DhcpEnumSubnetClientsV6, DhcpEnumSubnetClientsV6 function [DHCP], dhcp.dhcpenumsubnetclientsv6, dhcpsapi/DhcpEnumSubnetClientsV6	dhcpsapi.h		Windows	None supported	Windows Server 2008 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpEnumSubnetClientsV6 dhcpsapi/DhcpEnumSubnetClientsV6	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpEnumSubnetClientsV6

DhcpEnumSubnetClientsV6 function

-description

The DhcpEnumSubnetClientsV6 function returns an enumerated list of clients with served IP addresses in the specified subnet.

-parameters

-param ServerIpAddress [in]

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

-param SubnetAddress [in]

DHCP_IPV6_ADDRESS value containing the IP address of the subnet gateway.

-param ResumeHandle [in, out]

Pointer to a DHCP_RESUME_IPV6_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 subnet client information structures 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 subnet client information structures to return. If the number of remaining unenumerated options (in bytes) is less than this value, then that amount will be returned.

-param ClientInfo [out]

Pointer to a DHCP_CLIENT_INFO_ARRAY_V6 structure containing information on the clients served under this specific subnet. If no clients are available, this field will be null.

-param ClientsRead [out]

Pointer to a DWORD value that specifies the number of clients returned in ClientInfo.

-param ClientsTotal [out]

Pointer to a DWORD value that specifies the total number of clients for the specified subnet 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_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.