MprAdminInterfaceGetInfo 関数 (mprapi.h)

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

MprAdminInterfaceGetInfo 関数は、指定したサーバー上の指定したインターフェイスの情報を取得します。

構文

DWORD MprAdminInterfaceGetInfo(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwLevel,
  [in] LPBYTE            *lplpbBuffer
);

パラメーター

[in] hMprServer

クエリを実行するルーターを処理します。このハンドルは、 MprAdminServerConnect の以前の呼び出しから取得されます。

[in] hInterface

MprAdminInterfaceCreate の前回の呼び出しによって取得されたインターフェイスを処理します。

[in] dwLevel

lplpbBuffer パラメーターで情報を構造化する形式を表す DWORD 値。 dwLevel で使用できる値は、次の表に示すように、0、1、2、3 です。

値	構造体の形式
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 以降: MPR_INTERFACE_3

値 1、2、3 は、 ROUTER_CONNECTION_STATE型のインターフェイスに対してのみ有効です。

[in] lplpbBuffer

MPR_INTERFACE_0へのポインター、MPR_INTERFACE_1、
MPR_INTERFACE_2、または MPR_INTERFACE_3 構造体。 dwLevel パラメーターは、構造体の種類を示します。 MprAdminBufferFree を呼び出して、このメモリを解放します。

戻り値

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

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

値	意味
ERROR_ACCESS_DENIED	呼び出し元のアプリケーションに十分な特権がありません。
ERROR_INVALID_LEVEL	dwLevel は 2 ですが、そのレベルはインターフェイスではサポートされていません。たとえば、MPR_INTERFACE_X構造体で定義されているインターフェイスの型は IF_TYPE_FULL_ROUTERされません。
ERROR_INVALID_HANDLE	hInterface 値が無効です。
ERROR_INVALID_PARAMETER	lplpbBuffer パラメーターは NULL です。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するためのリソースが不足しています。
ERROR_NOT_SUPPORTED	dwLevel 値が無効です。

要件

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