MprAdminConnectionGetInfo 関数 (mprapi.h)

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

MprAdminConnectionGetInfo 関数は、特定の接続に関するデータを取得します。

構文

DWORD MprAdminConnectionGetInfo(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer
);

パラメーター

[in] hRasServer

接続情報の取得元のコンピューターへのハンドル。このハンドルを取得するには、 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

[in] hRasConnection

データを取得するための接続へのハンドル。このハンドルを取得するには、 MprAdminConnectionEnum を呼び出します。

[out] lplpbBuffer

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

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

戻り値

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

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

リターンコード	説明
ERROR_INVALID_PARAMETER	RAS サーバーへのハンドルまたは RAS 接続へのハンドルが無効です。
ERROR_INVALID_LEVEL	dwLevel に渡される値は、0、1、2、または 3 ではありません。レベル 1 とレベル 2 は、Windows 2000 以降でのみサポートされています。レベル 3 は、Windows Server 2008 以降でのみサポートされています。
ERROR_INTERFACE_NOT_CONNECTED	hConnection ハンドルが無効です。
RPC_S_INVALID_BINDING	hRasServer ハンドルが無効です。
その他	MprError.h、RasError.h、または WinError.h からのエラー。

注釈

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

要件

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