DhcpV4FailoverDeleteRelationship function (dhcpsapi.h)

The DhcpV4FailoverDeleteRelationship function deletes a DHCPv4 failover relationship between two servers.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4FailoverDeleteRelationship(
  [in, optional] LPWSTR ServerIpAddress,
  [in]           LPWSTR pRelationshipName
);

Parameters

[in, optional] ServerIpAddress

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

[in] pRelationshipName

Pointer to null-terminated Unicode string that represents the name of the relationship to delete.

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.

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.

Requirements

   
Minimum supported client None supported
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dhcpsapi.h
Library Dhcpsapi.lib
DLL Dhcpsapi.dll

See also

DhcpV4FailoverCreateRelationship

DhcpV4FailoverEnumRelationship

DhcpV4FailoverGetRelationship

DhcpV4FailoverSetRelationship