RasAdminPortClearStatistics

The RasAdminPortClearStatistics function resets the counters representing the various statistics reported by the RasAdminPortGetInfo function in the RAS_PORT_STATISTICS structure. The counters are reset to zero and start accumulating from then on.

DWORD RasAdminPortClearStatistics(
  const WCHAR *lpszServer,  // pointer to the server name
  const WCHAR *lpszPort  // pointer to the name of port on the server
);

Parameters

lpszServer

Pointer to a null-terminated Unicode string that contains the name of the Windows NT/Windows 2000 RAS server. Specify the name with leading "\\" characters, in the form: \\servername.

lpszPort

Pointer to a null-terminated Unicode string that contains the name of the port on the server.

Return Values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value can be the following error code.

There is no extended error information for this function; do not call GetLastError.

Remarks

The RasAdminPortClearStatistics function clears the statistics on the server, not locally within the application that makes the call. This means that the statistics are also reset for any other application that is monitoring the specified port.

If the lpszPort port is part of a multilink connection, RasAdminPortClearStatistics resets the statistics for the specified port, The function also resets the cumulative statistics for the multilink connection. However, the function does not effect the individual statistics for other ports that are part of the multilink connection.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Header: Declared in Rassapi.h.
  Library: Use Rassapi.lib.

See Also

Remote Access Service (RAS) Overview, RAS Server Administration Functions, RAS_PORT_STATISTICS, RasAdminPortGetInfo