DhcpV4FailoverGetScopeRelationship function

The DhcpV4FailoverGetScopeRelationship function retrieves the failover relationship that is configured on a specified DHCPv4 scope.

Syntax


DWORD DHCP_API_FUNCTION DhcpV4FailoverGetScopeRelationship(
  _In_opt_ LPWSTR                       ServerIpAddress,
  _In_     DHCP_IP_ADDRESS              scopeId,
  _Out_    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.

scopeId [in]

A DHCP_IP_ADDRESS field that contains the IPv4 scope address for which the relationship details are to be retrieved.

pRelationship [out]

Pointer to a DHCP_FAILOVER_RELATIONSHIP structure that contains information about the retrieved failover relationship which contains scopeId field in its pScopes member.

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.

ValueMeaning
ERROR_INVALID_PARAMETER

One or more of the parameters were invalid.

ERROR_DHCP_FO_SCOPE_NOT_IN_RELATIONSHIP

IPv4 subnet is not part of the failover relationship.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dhcpsapi.h

Library

Dhcpsapi.lib

DLL

Dhcpsapi.dll

See also

DhcpV4FailoverAddScopeToRelationship
DhcpV4FailoverDeleteScopeFromRelationship
DhcpV4FailoverGetScopeStatistics

 

 

Show: