MprAdminConnectionEnum 関数 (mprapi.h)

[アーティクル]
02/29/2024

MprAdminConnectionEnum 関数は、アクティブなすべての接続を列挙します。

構文

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

パラメーター

[in] hRasServer

接続が列挙される RAS サーバーに対して処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。

[in] dwLevel

lplpbBuffer パラメーターで情報が返される形式を表す DWORD 値。 dwLevel に使用できる値は、次の表に示すように、0、1、2、および 3 です。

Windows NT 4.0: このパラメーターは 0 である必要があります。

値	構造体の形式
0	RAS_CONNECTION_0
1	Windows 2000 以降: RAS_CONNECTION_1
2	Windows 2000 以降: RAS_CONNECTION_2
3	Windows Server 2008 以降: RAS_CONNECTION_3

[out] lplpbBuffer

正常に完了すると、接続を記述する構造体の配列へのポインター。これらの構造体の型は、dwLevel パラメーターの値に応じて、RAS_CONNECTION_0、RAS_CONNECTION_1、RAS_CONNECTION_2、またはRAS_CONNECTION_3です。

このメモリを解放するには、 MprAdminBufferFree を呼び出します。

[in] dwPrefMaxLen

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

[out] lpdwEntriesRead

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

[out] lpdwTotalEntries

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

[in] lpdwResumeHandle

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

戻り値

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

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

値	意味
ERROR_DDM_NOT_RUNNING	ダイナミックインターフェイスマネージャー (DIM) が LAN でのみ実行されるように構成されている可能性があるため、Demand Dial Manager (DDM) が実行されていません。
ERROR_INVALID_LEVEL	dwLevel に渡される値は、0、1、2、または 3 ではありません。レベル 1 とレベル 2 は、Windows 2000 以降でのみサポートされています。レベル 3 は、Windows Server 2008 以降でのみサポートされています。
ERROR_INVALID_PARAMETER	次のパラメーターの少なくとも 1 つが NULL であるか、有効なメモリを指していません: lplpBuffer、 lpdwEntriesRead、または lpdwTotalEntries。
ERROR_MORE_DATA	この呼び出しで、すべてのデータが返されたわけではありません。追加のデータを取得するには、再開ハンドルを使用して関数をもう一度呼び出します。
RPC_S_INVALID_BINDING	hRasServer パラメーターで渡されるハンドルが NULL または無効です。
その他	MprError.h、RasError.h、または WinError.h からのエラー。

注釈

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

要件

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