RasAdminPortEnum 関数

  • [アーティクル]

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

RasAdminPortEnum 関数は、指定された RAS サーバー上のすべてのポートを列挙します。 サーバー上のポートごとに、関数はポートに関する情報を含む RAS_PORT_0 構造体を返します。

構文

DWORD RasAdminPortEnum(
  _In_  const WCHAR       *lpszServer,
  _Out_       PRAS_PORT_0 *ppRasPort0,
  _Out_       WORD        *pcEntriesRead
);

パラメーター

lpszServer [in]

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

ppRasPort0 [out]

RAS_PORT_0構造体の配列を含むバッファーへのポインターを受け取る変数へのポインター。 アプリケーションがメモリで終了したら、 RasAdminFreeBuffer 関数を呼び出して解放します。

pcEntriesRead [out]

ppRasPort0 配列で返されるRAS_PORT_0構造体の合計数を受け取る 16 ビット変数へのポインター。

戻り値

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

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

値 説明
NERR_ItemNotFound
 ポートを列挙できませんでした。 これは、サーバー上で構成されているすべてのポートが現在ダイヤルアウトに使用されていることが原因である可能性があります。

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

要件

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

関連項目

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

RAS サーバー管理機能

RAS_PORT_0

RasAdminFreeBuffer