MprAdminTransportGetInfo 関数 (mprapi.h)
MprAdminTransportGetInfo 関数は、指定されたトランスポートのグローバル情報、既定のクライアント インターフェイス情報、またはその両方を取得します。
構文
DWORD MprAdminTransportGetInfo(
[in] MPR_SERVER_HANDLE hMprServer,
[in] DWORD dwTransportId,
[out, optional] LPBYTE *ppGlobalInfo,
[out, optional] LPDWORD lpdwGlobalInfoSize,
[out, optional] LPBYTE *ppClientInterfaceInfo,
[out, optional] LPDWORD lpdwClientInterfaceInfoSize
);
パラメーター
[in] hMprServer
情報の取得元となるルーターに対して処理します。 このハンドルは、 MprAdminServerConnect の以前の呼び出しから取得されます。
[in] dwTransportId
取得するトランスポートの種類を表す DWORD 値。 dwTransportId に使用できる値を次の表に示します。
| 値 | トランスポート (プロトコル ファミリ) |
|---|---|
| PID_ATALK | Appletalk |
| PID_IP | インターネット プロトコル バージョン 4 |
| PID_IPX | インターネット パケット交換 |
| PID_NBF | NetBIOS フレーム プロトコル |
| PID_IPV6 | Windows Server 2008 以降: インターネット プロトコル バージョン 6 |
[out, optional] ppGlobalInfo
ポインター変数へのポインター。 この変数は、このトランスポートのグローバル情報を受け取る情報ヘッダーを指します。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。
MprAdminBufferFree を呼び出して、このメモリを解放します。
このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はグローバル情報を取得しません。
[out, optional] lpdwGlobalInfoSize
DWORD 変数へのポインター。 この変数は、トランスポートのグローバル情報のサイズ (バイト単位) を受け取ります。
[out, optional] ppClientInterfaceInfo
ポインター変数へのポインター。 この変数は、このトランスポートの既定のクライアント インターフェイス情報を指します。 MprAdminBufferFree を呼び出して、このメモリを解放します。
このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はクライアント インターフェイス情報を取得しません。
[out, optional] lpdwClientInterfaceInfoSize
DWORD 変数へのポインター。 この変数は、クライアント インターフェイス情報のサイズ (バイト単位) を受け取ります。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 意味 |
|---|---|
|
呼び出し元アプリケーションに十分な特権がありません。 |
|
次のいずれかが当てはまります。
|
|
操作を完了するためのリソースが不足しています。 |
|
dwTransportId 値は、インストールされているトランスポートと一致しません。 |
注釈
ppGlobalInfo パラメーターと ppClientInterfaceInfo パラメーターの両方を NULL にすることはできません。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |