RasAdminPortGetInfo 関数

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

RasAdminPortGetInfo 関数は、指定したサーバー上の指定したポートに関する情報を取得します。

構文

DWORD RasAdminPortGetInfo(
  _In_  const WCHAR               *lpszServer,
  _In_  const WCHAR               *lpszPort,
  _Out_       RAS_PORT_1          *pRasPort1,
  _Out_       RAS_PORT_STATISTICS *pRasStats,
  _Out_       RAS_PARAMETERS      **ppRasParams
);

パラメーター

lpszServer [in]

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

lpszPort [in]

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

pRasPort1 [out]

関数がポートの状態に関する情報を入力する RAS_PORT_1 構造体へのポインター。

pRasStats [out]

関数がポートに関する統計情報を入力する RAS_PORT_STATISTICS 構造体へのポインター。

ppRasParams [out]

構造体の配列のアドレスを受け取るポインター変数へのポインター RAS_PARAMETERS 。 各構造体には、MAXCONNECTBPS などのメディア固有キーの名前とそれに関連する値が含まれています。 アプリケーションがこのメモリで終了したら、 RasAdminFreeBuffer 関数を呼び出して解放します。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

説明
ERROR_DEV_NOT_EXIST
指定したポートが無効です。
ERROR_NOT_ENOUGH_MEMORY
ppRasParams 配列のバッファーを割り当てるメモリが不足しています。

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

必要条件

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

関連項目

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

RAS サーバー管理機能

RAS_PARAMETERS

RAS_PORT_1

RAS_PORT_STATISTICS

RasAdminFreeBuffer