Edit

DhcpV4FailoverGetScopeStatistics function (dhcpsapi.h)

  • Article

The DhcpV4FailoverGetScopeStatistics function retrieves the address usage statistics of a specific scope that is part of a failover relationship.

Syntax

DWORD DHCP_API_FUNCTION DhcpV4FailoverGetScopeStatistics(
  [in, optional] LPWSTR                     ServerIpAddress,
  [in]           DHCP_IP_ADDRESS            ScopeId,
  [out]          LPDHCP_FAILOVER_STATISTICS *pStats
);

Parameters

[in, optional] ServerIpAddress

Pointer to a null-terminated Unicode string that represents the IP address or hostname of the DHCP server.

[in] ScopeId

DHCP_IP_ADDRESS structure that contains the IPv4 scope address of the address usage statistics to retrieve.

[out] pStats

Pointer to a DHCP_FAILOVER_STATISTICS structure that contains the address usage information for scopeId.

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.

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

DhcpV4FailoverDeleteScopeFromRelationship

DhcpV4FailoverGetScopeRelationship