MprAdminPortEnum 関数 (mprapi.h)

[アーティクル]
08/24/2023

MprAdminPortEnum 関数は、特定の接続内のすべてのアクティブなポート、または RAS で使用できるポートまたは現在使用されているすべてのポートを列挙します。

構文

DWORD MprAdminPortEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

パラメーター

[in] hRasServer

ポートを列挙する RAS サーバーへのハンドル。このハンドルを取得するには、 MprAdminServerConnect を呼び出します。

[in] dwLevel

lplpbBuffer パラメーターで情報が返される形式を表す DWORD 値。ゼロを指定してください。

[in] hRasConnection

アクティブなポートが列挙される接続へのハンドル。このパラメーターが INVALID_HANDLE_VALUEされている場合、RRAS で使用できるポートまたは使用できるすべてのポートが列挙されます。このハンドルを取得するには、 MprAdminConnectionEnum を呼び出します。

[out] lplpbBuffer

正常に完了すると、ポートを記述する RAS_PORT_0 構造体の配列へのポインター。 MprAdminBufferFree を呼び出して、このメモリを解放します。

[in] dwPrefMaxLen

返されるデータの推奨される最大長を 8 ビットバイトで指定する値。このパラメーターが -1 の場合、返されるバッファーは、使用可能なすべてのデータを保持するのに十分な大きさです。

[out] lpdwEntriesRead

DWORD 変数へのポインター。この変数は、現在の再開位置から列挙されたポートの合計数を受け取ります。

[out] lpdwTotalEntries

DWORD 変数へのポインター。この変数は、現在の再開位置から列挙された可能性のあるポートの合計数を受け取ります。

[in] lpdwResumeHandle

DWORD 変数へのポインター。正常に実行されると、このパラメーターは列挙を再開するために使用できるハンドルを指定します。このパラメーターは、最初の呼び出しでは 0 で、後続の呼び出しでは変更されません。戻りコードが ERROR_MORE_DATA場合は、ハンドルを使用して呼び出しを再発行して、より多くのデータを取得できます。戻り値のハンドルが NULL の 場合、列挙を続行できません。このハンドルは、他の種類のエラーの戻り値には無効です。

戻り値

関数が成功した場合、戻り値は NO_ERROR。

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

値	意味
ERROR_ACCESS_DENIED	呼び出し元のアプリケーションに十分な特権がありません。
ERROR_DDM_NOT_RUNNING	Dynamic Interface Manager (DIM) が LAN でのみ実行するように構成されている可能性があるため、Demand Dial Manager (DDM) が実行されていません。
ERROR_INVALID_PARAMETER	次のパラメーターの少なくとも 1 つが NULL であるか、有効なメモリを指していません: lplpBuffer、 lpdwEntriesRead、または lpdwTotalEntries。
ERROR_MORE_DATA	この呼び出しで、すべてのデータが返されたわけではありません。追加のデータを取得するには、 IpdwResumeHandle パラメーターで返されたハンドルを使用して、関数をもう一度呼び出します。
ERROR_NOT_SUPPORTED	dwLevel パラメーターが 0 ではありません。
ERROR_INVALID_HANDLE	hConnection パラメーターは NULL です。
その他	MprError.h、RasError.h、または WinError.h からのエラー。

注釈

RRAS 再頒布可能パッケージがインストールされている場合、この機能は Windows NT 4.0 で使用できます。ただし、RRAS 再頒布可能パッケージと共に提供される Mprapi.dll のバージョンでは、関数は MprAdminPortEnum ではなく RasAdminPortEnum としてエクスポートされます。したがって、RRAS 再頒布可能パッケージを使用する場合は、 LoadLibrary と GetProcAddress を使用してこの関数にアクセスします。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	mprapi.h
Library	Mprapi.lib
[DLL]	Mprapi.dll