DhcpV4FailoverAddScopeToRelationship function

The DhcpV4FailoverAddScopeToRelationship function adds a DHCPv4 scope to the specified failover relationship.

Syntax


DWORD DHCP_API_FUNCTION DhcpV4FailoverAddScopeToRelationship(
  _In_opt_ LPWSTR                       ServerIpAddress,
  _In_     LPDHCP_FAILOVER_RELATIONSHIP pRelationship
);

Parameters

ServerIpAddress [in, optional]

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

pRelationship [in]

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

Return value

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.

ValueMeaning
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.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpV4FailoverDeleteScopeFromRelationship
DhcpV4FailoverGetScopeRelationship
DhcpV4FailoverGetScopeStatistics

 

 

Show: