DhcpV4FailoverGetScopeRelationship function (dhcpsapi.h)
The DhcpV4FailoverGetScopeRelationship function retrieves the failover relationship that is configured on a specified DHCPv4 scope.
Syntax
DWORD DHCP_API_FUNCTION DhcpV4FailoverGetScopeRelationship(
[in, optional] LPWSTR ServerIpAddress,
[in] DHCP_IP_ADDRESS ScopeId,
[out] 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] ScopeId
A DHCP_IP_ADDRESS field that contains the IPv4 scope address for which the relationship details are to be retrieved.
[out] pRelationship
Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains information about the retrieved failover relationship which contains scopeId field in its pScopes member.
The memory for this parameter must be free using DhcpRpcFreeMemory.
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 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