nf-dhcpsapi-dhcpv4failoverenumrelationship.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.DhcpV4FailoverEnumRelationship	DhcpV4FailoverEnumRelationship function (dhcpsapi.h)	Enumerates all failover relationships present on the server.	DhcpV4FailoverEnumRelationship DhcpV4FailoverEnumRelationship function [DHCP] dhcp.dhcpv4failoverenumrelationship dhcpsapi/DhcpV4FailoverEnumRelationship	dhcp\dhcpv4failoverenumrelationship.htm	DHCP	81ef2af8-c1a9-44e7-857c-1591947609ed	12/05/2018	DhcpV4FailoverEnumRelationship, DhcpV4FailoverEnumRelationship function [DHCP], dhcp.dhcpv4failoverenumrelationship, dhcpsapi/DhcpV4FailoverEnumRelationship	dhcpsapi.h		Windows	None supported	Windows Server 2012 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpV4FailoverEnumRelationship dhcpsapi/DhcpV4FailoverEnumRelationship	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpV4FailoverEnumRelationship

DhcpV4FailoverEnumRelationship function

-description

The DhcpV4FailoverEnumRelationship function enumerates all failover relationships present on the server.

-parameters

-param ServerIpAddress [in, optional]

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

-param ResumeHandle [in, out]

Pointer to a DHCP_RESUME_HANDLE structure that identifies this enumeration for use in subsequent calls to this function.

Initially, this value should be zero on input. If successful, the returned value should be used for subsequent enumeration requests. For example, if PreferredMaximum is set to 100, and 200 reservation elements are configured on the server, the resume handle can be used after the first 100 policies are retrieved to obtain the next 100 on a subsequent call.

-param PreferredMaximum [in]

The maximum number of failover relationship elements to return in pRelationship. If PreferredMaximum is greater than the number of remaining non-enumerated policies on the server, the remaining number of non-enumerated policies is returned.

-param pRelationship [out]

Pointer to a DHCP_FAILOVER_RELATIONSHIP_ARRAY structure that contains an array of the failover relationships available on the DHCP server. If no relationships are configured, this value is NULL.

-param RelationshipRead [out]

Pointer to a DWORD that specifies the number of failover relationship elements returned in pRelationship.

-param RelationshipTotal [out]

Pointer to a DWORD that specifies the number of failover relationships configured on the DHCP server that have not yet been enumerated.

-returns

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the following. or an error code from DHCP Server Management API Error Codes

Value	Meaning
ERROR_INVALID_PARAMETER	One or more of the parameters were invalid.
ERROR_MORE_DATA	There are more elements available to enumerate.
ERROR_NO_MORE_ITEMS	There are no more elements left to enumerate.

-see-also

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverGetRelationship

DhcpV4FailoverSetRelationship