RasAdminPortClearStatistics function

Article
11/30/2023

[This function is provided only for backward compatibility with Windows NT Server 4.0. It returns ERROR_CALL_NOT_IMPLEMENTED on Windows Server 2003. Applications should use the MprAdminPortClearStats function.]

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.

Syntax

DWORD RasAdminPortClearStatistics(
  _In_ const WCHAR *lpszServer,
  _In_ const WCHAR *lpszPort
);

Parameters

lpszServer [in]: Pointer to a null-terminated Unicode string that specifies the name of the RAS server. Specify the name with leading "\\" characters, in the form: \\servername.
lpszPort [in]: Pointer to a null-terminated Unicode string that specifies the name of the port on the server.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

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

Value	Meaning
ERROR_DEV_NOT_EXIST	The specified port is invalid.

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 affect the individual statistics for other ports that are part of the multilink connection.

Requirements

Requirement	Value
End of client support	Windows 2000 Professional
End of server support	Windows 2000 Server
Header	Rassapi.h
Library	Rassapi.lib
DLL	Rassapi.dll