nf-dhcpsapi-dhcpv4failoversetrelationship.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.DhcpV4FailoverSetRelationship	DhcpV4FailoverSetRelationship function (dhcpsapi.h)	Sets or modifies the parameters of a DHCPv4 server failover relationship.	CHANGESTATE DhcpV4FailoverSetRelationship DhcpV4FailoverSetRelationship function [DHCP] MCLT MODE PERCENTAGE PREVSTATE SAFEPERIOD dhcp.dhcpv4failoversetrelationship dhcpsapi/DhcpV4FailoverSetRelationship	dhcp\dhcpv4failoversetrelationship.htm	DHCP	04012953-dca3-426f-99de-798870d1eb97	12/05/2018	CHANGESTATE, DhcpV4FailoverSetRelationship, DhcpV4FailoverSetRelationship function [DHCP], MCLT, MODE, PERCENTAGE, PREVSTATE, SAFEPERIOD, dhcp.dhcpv4failoversetrelationship, dhcpsapi/DhcpV4FailoverSetRelationship	dhcpsapi.h		Windows	None supported	Windows Server 2012 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpV4FailoverSetRelationship dhcpsapi/DhcpV4FailoverSetRelationship	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpV4FailoverSetRelationship

DhcpV4FailoverSetRelationship function

-description

The DhcpV4FailoverSetRelationship function sets or modifies the parameters of a DHCPv4 server failover relationship.

-parameters

-param ServerIpAddress [in, optional]

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

-param Flags [in]

A bitmask that specifies the fields to update in pRelationship. Each value specifies a member of the DHCP_FAILOVER_RELATIONSHIP structure to be modified.

Flag	Meaning
MCLT 0x00000001	The mclt member in pRelationship parameter structure is populated.
SAFEPERIOD 0x00000002	The safePeriod member in pRelationship parameter structure is populated.
CHANGESTATE 0x00000004	The state member in pRelationship parameter structure is populated.
PERCENTAGE 0x00000008	The percentage member in pRelationship parameter structure is populated.
MODE 0x00000010	The mode member in pRelationship parameter structure is populated.
PREVSTATE 0x00000020	The prevState member in pRelationship parameter structure is populated.

-param pRelationship [in]

Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains update information about the fields in the DHCPv4 failover relationship.

-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_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST	The failover relationship doesn’t exist.

-see-also

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverEnumRelationship

DhcpV4FailoverGetRelationship