Share via


RasGetLinkStatistics (Compact 2013)

3/26/2014

This function retrieves accumulated statistics for the specified link in a RAS multilink connection.

Syntax

DWORD RasGetLinkStatistics(
  HRASCONN hRasConn, 
  DWORD dwSubEntry, 
  RAS_STATS* lpStatistics 
);

Parameters

  • hRasConn
    Handle to the connection. Use RasDial or RasEnumConnections to obtain this handle.
  • dwSubEntry
    Specifies the subentry that corresponds to the link for which to retrieve statistics.
  • lpStatistics
    Pointer to a RAS_STATS structure to receive the statistics. Set the dwSize member of this structure to sizeof(RAS_STATS) before calling RasGetLinkStatistics. This parameter cannot be NULL.

Return Value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is one of the following error codes.

Value

Description

E_INVALID_ARG

At least one of the following is true: the hRasConn parameter is zero, the dwSubEntry parameter is zero, the lpStatistics parameter is NULL, or the value specified by the dwSize member of the RAS_STATS structure specifies a version of the structure that is not supported by the operating system in use.

ERROR_NOT_ENOUGH_MEMORY

The function could not allocate sufficient memory to complete the operation.

Other

Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

Header

ras.h

Library

coredll.lib

See Also

Reference

RAS Functions
RasDial
RasEnumConnections
RasGetConnectStatus