DhcpV4FailoverDeleteScopeFromRelationship function (dhcpsapi.h)
The DhcpV4FailoverDeleteScopeFromRelationship function deletes a DHCPv4 scope from the specified failover relationship.
Syntax
DWORD DHCP_API_FUNCTION DhcpV4FailoverDeleteScopeFromRelationship(
[in, optional] LPWSTR ServerIpAddress,
[in] LPDHCP_FAILOVER_RELATIONSHIP pRelationship
);
Parameters
[in, optional] ServerIpAddress
Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.
[in] pRelationship
Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains the scopes to delete. The scopes are defined in the pScopes member of this structure.
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 |
|---|---|
|
One or more of the parameters were invalid. |
|
IPv4 scope doesn't exist on the DHCPv4 server. |
|
Failover relationship doesn't exist. |
|
IPv4 subnet is not part of the failover relationship. |
Requirements
| Requirement | Value |
|---|---|
| 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
DhcpV4FailoverAddScopeToRelationship