MprConfigTransportSetInfo 関数 (mprapi.h)

[アーティクル]
03/15/2023

MprConfigTransportSetInfo 関数は、指定したルーター構成の指定されたトランスポートプロトコルの構成を変更します。

構文

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

パラメーター

[in] hMprConfig

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

[in] hRouterTransport

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

[in, optional] pGlobalInfo

トランスポートプロトコルのグローバル情報を指定する情報ヘッダーへのポインター。この情報は、トランスポートのルーターマネージャーによって解釈されます。情報ヘッダー関数を使用して、情報ヘッダーを操作します。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。

[in, optional] dwGlobalInfoSize

pGlobalInfo によって指されるデータのサイズをバイト単位で指定します。呼び出し元のアプリケーションで pGlobalInfo に NULL が指定されている場合、呼び出し元のアプリケーションでは、このパラメーターに 0 を指定する必要があります。

[in, optional] pClientInterfaceInfo

クライアントルーターの既定のインターフェイス情報を指定する情報ヘッダーへのポインター。この情報は、このトランスポート用のクライアントルーターの動的インターフェイスを構成するために使用されます。情報ヘッダー関数を使用して、情報ヘッダーを操作します。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。

[in, optional] dwClientInterfaceInfoSize

pClientInterfaceInfo が指すデータのサイズをバイト単位で指定します。呼び出し元のアプリケーションで pClientInterfaceInfo に NULL が指定されている場合、呼び出し元のアプリケーションでは、このパラメーターに 0 を指定する必要があります。

[in, optional] lpwsDLLPath

指定したトランスポートのルーターマネージャー DLL の名前を指定する null で終わる Unicode 文字列へのポインター。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。

戻り値

関数が成功した場合、戻り値はNO_ERROR。詳細については、このトピックで後述する「解説」を参照してください。

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

値	意味
ERROR_INVALID_PARAMETER	hMprConfig パラメーターが NULL、hRouterTransport パラメーターが NULL、または両方が NULL です。
ERROR_UNKNOWN_PROTOCOL_ID	hRouterTransport に対応するトランスポートプロトコル構成がルーター構成で見つかりませんでした。
その他	FormatMessage を使用して、返されたエラーコードに対応するシステムエラーメッセージを取得します。

注釈

MprConfigTransportSetInfo を使用して、トランスポートのグローバル情報、既定のインターフェイス情報、またはトランスポートのルーターマネージャー DLL の名前を設定します。

MprConfigTransportSetInfo は、パラメーターリストに表示される順序で項目を設定しようとします。

グローバル情報。
クライアントルーターの既定のインターフェイス情報。
ルーターマネージャーの DLL 名。

MprConfigTransportSetInfo がいずれかの項目を設定できない場合は、残りの項目を設定せずにすぐにが返されます。

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

要件

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