Platform SDK: RAS/Routing and RAS

RasGetLinkStatistics

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

DWORD RasGetLinkStatistics (
  HRASCONN hRasConn,      // handle to connection
  DWORD dwSubEntry,       // SubEntry for link
  RAS_STATS *lpStatistics // buffer to receive statistics
);

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 Values

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 Meaning
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

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Ras.h.
  Library: Use Rasapi32.lib.

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RasClearLinkStatistics, RasDial, RasEnumConnections, RasGetConnectionStatistics