nf-dhcpsapi-dhcpenumsubnetclientsfilterstatusinfo.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.DhcpEnumSubnetClientsFilterStatusInfo	DhcpEnumSubnetClientsFilterStatusInfo function (dhcpsapi.h)	Enumerates all of the DHCP clients serviced on the specified subnet, and includes link-layer filter status for each of them.	DhcpEnumSubnetClientsFilterStatusInfo DhcpEnumSubnetClientsFilterStatusInfo function [DHCP] dhcp.dhcpenumsubnetclientsfilterstatusinfo dhcpsapi/DhcpEnumSubnetClientsFilterStatusInfo	dhcp\dhcpenumsubnetclientsfilterstatusinfo.htm	DHCP	a88455ca-ba64-46d0-af8f-be90c57d96f3	12/05/2018	DhcpEnumSubnetClientsFilterStatusInfo, DhcpEnumSubnetClientsFilterStatusInfo function [DHCP], dhcp.dhcpenumsubnetclientsfilterstatusinfo, dhcpsapi/DhcpEnumSubnetClientsFilterStatusInfo	dhcpsapi.h		Windows	None supported	Windows Server 2008 R2 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpEnumSubnetClientsFilterStatusInfo dhcpsapi/DhcpEnumSubnetClientsFilterStatusInfo	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpEnumSubnetClientsFilterStatusInfo

DhcpEnumSubnetClientsFilterStatusInfo function

-description

The DhcpEnumSubnetClientsFilterStatusInfo function enumerates all of the DHCP clients serviced on the specified subnet, and includes link-layer filter status for each of them.

-parameters

-param ServerIpAddress [in]

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

-param SubnetAddress [in]

DHCP_IP_ADDRESS value that contains the IPv4 subnet for which the DHCP clients are returned. If this parameter is set to 0, the DHCP clients for all known IPv4 subnets are returned.

-param ResumeHandle [in, out]

Pointer to a DHCP_RESUME_HANDLE value that identifies the enumeration operation on the DHCP server. Initially, this value must be set to 0. A successful call will return a handle value in this parameter, which can be passed to subsequent enumeration requests. The returned handle value is the last IPv4 address retrieved in the enumeration operation.

-param PreferredMaximum [in]

Specifies the preferred maximum number of bytes to return in the enumeration operation. the minimum value is 1024 bytes, and the maximum value is 65536 bytes.

-param ClientInfo [out]

Pointer to a DHCP_CLIENT_FILTER_STATUS_INFO_ARRAY structure that contains all of the DHCP clients serviced on the specified subnet, as well as any associated link-layer filter status information for each of them.

-param ClientsRead [out]

Pointer to a value that specifies the number of DHCP client records returned in ClientInfo.

-param ClientsTotal [out]

Pointer to a value that specifies the number of DHCP client record remaining and as-yet unreturned. For example, if there are 100 DHCP client records for a given IPv4 subnet, and if 10 client records are enumerated per call, then after the first call this value would return 90.

-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.
ERROR_MORE_DATA	There are still unenumerated client lease records on the DHCP server for the provided IPv4 subnet. Please call this function again with the returned resume handle to obtain more of them.

-see-also

DHCP_CLIENT_FILTER_STATUS_INFO_ARRAY