MprConfigTransportGetInfo 関数 (mprapi.h)

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

MprConfigTransportGetInfo 関数は、指定されたトランスポートプロトコルの構成をルーターから取得します。

構文

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

パラメーター

[in] hMprConfig

ルーターの構成を処理します。 MprConfigServerConnect を呼び出して、このハンドルを取得します。

[in] hRouterTransport

取得するトランスポートプロトコル構成を処理します。 MprConfigTransportCreate、MprConfigTransportGetHandle、または MprConfigTransportEnum を呼び出して、このハンドルを取得します。サポートされているトランスポートプロトコルの種類は、「トランスポート識別子」に一覧表示されます。

[in, out, optional] ppGlobalInfo

入力時に、ポインター変数へのポインター。

出力時に、このポインター変数は、トランスポートのグローバル情報を含む情報ヘッダーを指します。情報ヘッダー関数を使用して、情報ヘッダーを操作します。 MprConfigBufferFree を呼び出して、このバッファーを解放します。

このパラメーターは省略可能です。呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はグローバル情報を取得しません。

[out, optional] lpdwGlobalInfoSize

DWORD 変数へのポインター。この変数は、 ppGlobalInfo パラメーターを介して返されるバッファーのサイズをバイト単位で受け取ります。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。ただし、 ppGlobalInfo が NULL でない場合、このパラメーターを NULL にすることはできません。

[in, out, optional] ppClientInterfaceInfo

入力時に、ポインター変数へのポインター。

出力時に、このポインターは、このトランスポート用のクライアントルーターの既定のインターフェイス情報を含む情報ヘッダーを指します。情報ヘッダー関数を使用して、情報ヘッダーを操作します。 MprConfigBufferFree を呼び出してバッファーを解放します。

このパラメーターは省略可能です。呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はインターフェイス情報を取得しません。

[out, optional] lpdwClientInterfaceInfoSize

DWORD 変数へのポインター。この変数は、 ppClientInterfaceInfo パラメーターを介して返されるバッファーのサイズをバイト単位で受け取ります。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。ただし、 ppClientInterfaceInfo が NULL でない場合、このパラメーターを NULL にすることはできません。

[in, out, optional] lplpwsDLLPath

入力時に、 null で終わる Unicode 文字列へのポインターへのポインター。

出力時に、Unicode 文字列は、指定されたトランスポートのルーターマネージャー DLL の名前を受け取ります。

このパラメーターは省略可能です。呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、この関数はルーターマネージャー DLL の名前を取得しません。

戻り値

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

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

値	説明
ERROR_INVALID_PARAMETER	以下のうち少なくとも 1 つが true です。 hMprConfig が NULL です hRouterTransport が NULL です ppGlobalInfo は NULL ではありませんが、 lpdwGlobalInfoSize は NULL です。 ppClientInterfaceInfo は NULL ではありませんが、 lpdwClientInterfaceInfo は NULL です。
ERROR_UNKNOWN_PROTOCOL_ID	hRouterTransport に対応するトランスポートプロトコル構成がルーター構成で見つかりませんでした。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するためのリソースが不足しています。
その他	FormatMessage を使用して、返されるエラーコードに対応するシステムエラーメッセージを取得します。

解説

pGlobalInfo、pClientInterfaceInfo、および lpwsDLLPath パラメーターがすべて NULL の場合、関数は何も実行せず、NO_ERRORの値を返します。

要件


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

次の方法で共有

MprConfigTransportGetInfo 関数 (mprapi.h)

構文

パラメーター

戻り値

解説

要件

関連項目

フィードバック

その他のリソース