Share via

3.1.4.4 RRasAdminConnectionClearStats (Opnum 3)

  • Article

The RRasAdminConnectionClearStats method resets the statistics counters for the connection identified by the passed handle in hDimConnection. The hDimServer handle specifies the RRASM server on which the call is executed.

 DWORD RRasAdminConnectionClearStats(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hDimConnection
 );

hDimServer: A handle to the RRAS server where the call is executed, see section 3.1.3.

hDimConnection: This is of type DWORD and SHOULD be set to the particular connection identifier for which the connection statistics have to be cleared. Obtain this handle by calling RRasAdminConnectionEnum (section 3.1.4.2). Because RRASM server does not maintain connection handle information, the validation of this handle SHOULD be done by the RRAS server implementation.

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 an error code, as specified in [MS-ERREF] or in section 2.2.4. All values that are not in the table that follows MUST be treated the same by the RRASM client.

Return value/code

Description

ERROR_SUCCESS

0x00000000

The call was successful.

ERROR_ACCESS_DENIED

0x00000005

The calling application does not have sufficient privileges as specified in section 2.1.1.1.

The opnum field value for this method is 3.

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

  • Validate, as specified in section 2.1.1.1, whether this method was called by a client that has access to the method. If the client does not have access, return error ERROR_ACCESS_DENIED (0x00000005).

  • If the RouterType is ROUTER_TYPE_LAN, return an error other than one of the errors listed in the preceding table.

  • Call the abstract interface Invoke DIMSVC method specifying the operation and the parameters to enable the RRAS server to perform the required management task.

  • If the operation completed successfully, return ERROR_SUCCESS (0x00000000).

  • Otherwise, return the error provided by the RRAS server.

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