RasAdminPortClearStatistics 関数

  • [アーティクル]

[この関数は、Windows NT Server 4.0 との下位互換性のためにのみ提供されています。 Windows Server 2003 では ERROR_CALL_NOT_IMPLEMENTED を返します。 アプリケーションは MprAdminPortClearStats 関数を使用する必要があります。]

RasAdminPortClearStatistics 関数は、RAS\_PORT\_STATISTICS 構造体の RasAdminPortGetInfo 関数によって報告されるさまざまな統計情報を表すカウンターをリセットします。 カウンターがゼロにリセットされ、累積を開始します。

構文

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

パラメーター

lpszServer [in]

RAS サーバーの名前を指定する、null で終わる Unicode 文字列へのポインター。 名前は、先頭に "\\" 文字を付けて、\\servername という形式で指定します。

lpszPort [in]

サーバー上のポートの名前を指定する、null で終わる Unicode 文字列へのポインター。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗すると、戻り値が次のエラーコードになる可能性があります。

値 意味
ERROR_DEV_NOT_EXIST
 指定したポートは無効です。

この関数の拡張エラー情報はありません。GetLastError を呼び出さないでください。

解説

RasAdminPortClearStatistics 関数は、呼び出しを行うアプリケーション内ローカルではなく、サーバー上の統計情報をクリアします。 つまり、指定されたポートを監視している他のアプリケーションについても、統計情報がリセットされます。

lpszPort ポートがマルチリンク接続の一部である場合、RasAdminPortClearStatistics は指定されたポートの統計情報をリセットします。この関数は、そのマルチリンク接続の累積統計もリセットします。 ただし、この関数は、マルチリンク接続の一部である他のポートの個々の統計情報には影響しません。

要件

要件 値
クライアント サポートの終了
 Windows 2000 Professional
サーバー サポートの終了
 Windows 2000 Server
ヘッダー
Rassapi.h
ライブラリ
Rassapi.lib
[DLL]
Rassapi.dll

関連項目

リモート アクセス サービス (RAS) の概要

RAS サーバー管理関数

RAS_PORT_STATISTICS

RasAdminPortGetInfo