DhcpV4FailoverDeleteScopeFromRelationship function
The DhcpV4FailoverDeleteScopeFromRelationship function deletes a DHCPv4 scope from the specified failover relationship.
Syntax
DWORD DHCP_API_FUNCTION DhcpV4FailoverDeleteScopeFromRelationship( _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 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
|
Minimum supported client | None supported [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
- DhcpV4FailoverAddScopeToRelationship
- DhcpV4FailoverGetScopeRelationship
- DhcpV4FailoverGetScopeStatistics
Send comments about this topic to Microsoft
Build date: 2/28/2013
