DhcpV4FailoverGetRelationship function (dhcpsapi.h)

The DhcpV4FailoverGetRelationship function retrieves relationship details for a specific relationship name.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetRelationship(
  [in, optional] LPWSTR                       ServerIpAddress,
  [in]           LPWSTR                       pRelationshipName,
  [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] pRelationshipName

Pointer to a null-terminated Unicode string which represents the name of the relationship to retrieve.

[out] pRelationship

Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains information about the retrieved failover relationship.

Note  

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
ERROR_INVALID_PARAMETER	One or more of the parameters were invalid.
ERROR_DHCP_FO_RELATIONSHIP_DOES_NOT_EXIST	The failover relationship does not exist.

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

DhcpV4FailoverCreateRelationship

DhcpV4FailoverDeleteRelationship

DhcpV4FailoverEnumRelationship

DhcpV4FailoverSetRelationship