nf-dhcpsapi-dhcpv4failoveraddscopetorelationship.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.DhcpV4FailoverAddScopeToRelationship	DhcpV4FailoverAddScopeToRelationship function (dhcpsapi.h)	Adds a DHCPv4 scope to the specified failover relationship.	DhcpV4FailoverAddScopeToRelationship DhcpV4FailoverAddScopeToRelationship function [DHCP] dhcp.dhcpv4failoveraddscopetorelationship dhcpsapi/DhcpV4FailoverAddScopeToRelationship	dhcp\dhcpv4failoveraddscopetorelationship.htm	DHCP	fc54b3dc-86b3-4a18-b05f-7152097f8d5b	12/05/2018	DhcpV4FailoverAddScopeToRelationship, DhcpV4FailoverAddScopeToRelationship function [DHCP], dhcp.dhcpv4failoveraddscopetorelationship, dhcpsapi/DhcpV4FailoverAddScopeToRelationship	dhcpsapi.h		Windows	None supported	Windows Server 2012 [desktop apps only]										Dhcpsapi.lib	Dhcpsapi.dll		Windows			19H1	DhcpV4FailoverAddScopeToRelationship dhcpsapi/DhcpV4FailoverAddScopeToRelationship	c++	APIRef kbSyntax	DllExport	Dhcpsapi.dll	DhcpV4FailoverAddScopeToRelationship

DhcpV4FailoverAddScopeToRelationship function

-description

The DhcpV4FailoverAddScopeToRelationship function adds a DHCPv4 scope to the specified 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 pRelationship [in]

Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains both the scope information to add and the failover relationship to modify.

-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_SUBNET_NOT_PRESENT	IPv4 scope doesn't exist on the DHCPv4 server.
ERROR_DHCP_FO_SCOPE_ALREADY_IN_RELATIONSHIP	IPv4 scope is already part of another failover relationship.
ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST	Failover relationship doesn't exist.
ERROR_DHCP_FO_MAX_ADD_SCOPES	Number of scopes being added to the failover relationship exceeds the max number of scopes which can be added to a failover relationship at one time.

-see-also

DhcpV4FailoverDeleteScopeFromRelationship

DhcpV4FailoverGetScopeRelationship

DhcpV4FailoverGetScopeStatistics