Share via

3.2.4.98 R_DhcpV4FailoverGetScopeStatistics (Opnum 97)

  • Article

The R_DhcpV4FailoverGetScopeStatistics method is used to retrieve the statistics of a IPv4 subnet configured for a failover relationship on the DHCPv4 server. The caller of this function can free the memory pointed to by the pStats parameter by calling the function midl_user_free (section 3).

 DWORD R_DhcpV4FailoverGetScopeStatistics(
   [in, unique, string] DHCP_SRV_HANDLE ServerIpAddress,
   [in] DHCP_IP_ADDRESS scopeId,
   [out] LPDHCP_FAILOVER_STATISTICS* pStats
 );

ServerIpAddress: The IP address/host name of the DHCP server. This parameter is unused.

scopeId: This is of type DHCP_IP_ADDRESS data type (section 2.2.1.2.1), that contains a IPv4 subnet address configured for a failover relationship for which statistics information needs to be returned.

pStats: This is a pointer of type LPDHCP_FAILOVER_STATISTICS (section 2.2.1.2.100) that contains the statistics information for the scopeId parameter.

Return Values: A 32-bit unsigned integer value that indicates return status. A return value of ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully. Otherwise, it contains a Win32 error code, as specified in [MS-ERREF]. This error code value can correspond to a DHCP-specific failure, which takes a value between 20000 and 20123, or any generic failure.

Return value/code

Description

0x00000000

ERROR_SUCCESS

The call was successful.

The opnum field value for this method is 97.

When processing this call, the DHCP server MUST do the following:

  • Return ERROR_INVALID_PARAMETER if any of the following are true.

    • scopeId parameter is 0.

    • pStats parameter is NULL.

  • Validate whether this method is authorized for read access as specified in section 3.5.4. If not, then return ERROR_ACCESS_DENIED.

  • Iterate through the DHCPv4FailoverStatisticsList ADM element and retrieve the DHCPv4FailoverStatistics ADM element whose scopeId member is equal to the passed in scopeId parameter. If the corresponding DHCPv4FailoverStatistics ADM element is not found, return ERROR_FILE_NOT_FOUND.

  • Allocate the memory for the pStats parameter, and copy the failover statistics information from the matching DHCPv4FailoverStatistics ADM element entry in the allocated memory.

  • Return ERROR_SUCCESS.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].