MprConfigTransportCreate 関数 (mprapi.h)
MprConfigTransportCreate 関数は、指定したルーター構成に存在するトランスポート プロトコルの一覧に、指定したトランスポートを追加します。
構文
DWORD MprConfigTransportCreate(
[in] HANDLE hMprConfig,
[in] DWORD dwTransportId,
[in, optional] LPWSTR lpwsTransportName,
[in] LPBYTE pGlobalInfo,
[in] DWORD dwGlobalInfoSize,
[in, optional] LPBYTE pClientInterfaceInfo,
[in, optional] DWORD dwClientInterfaceInfoSize,
[in, optional] LPWSTR lpwsDLLPath,
[out] HANDLE *phRouterTransport
);
パラメーター
[in] hMprConfig
トランスポートを追加するルーター構成を処理します。 MprConfigServerConnect を呼び出して、このハンドルを取得します。
[in] dwTransportId
構成に追加するトランスポートを表す DWORD 値。 このパラメーターは、トランスポートのルーター マネージャーも識別します。 dwTransportId に使用できる値を次の表に示します。
値 | トランスポート (プロトコル ファミリ) |
---|---|
PID_ATALK | Appletalk |
PID_IP | インターネット プロトコル バージョン 4 |
PID_IPX | インターネット パケット交換 |
PID_NBF | NetBIOS フレーム プロトコル |
PID_IPV6 | Windows Server 2008 以降: インターネット プロトコル バージョン 6 |
[in, optional] lpwsTransportName
追加するトランスポートの名前を指定する null で終わる Unicode 文字列へのポインター。 このパラメーターを指定しない場合、 dwTransportId パラメーターは文字列に変換され、トランスポート名として使用されます。
[in] pGlobalInfo
トランスポートのグローバル情報を指定する情報ヘッダーへのポインター。 この情報は、トランスポートのルーター マネージャーによって解釈されます。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。
[in] dwGlobalInfoSize
pGlobalInfo パラメーターによって指されるデータのサイズをバイト単位で指定します。
[in, optional] pClientInterfaceInfo
クライアント ルーターの既定のインターフェイス情報を指定する情報ヘッダーへのポインター。 この情報は、このトランスポート用のクライアント ルーターの動的インターフェイスを構成するために使用されます。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。
このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。
[in, optional] dwClientInterfaceInfoSize
pClientInterfaceInfo パラメーターによって指されるデータのサイズをバイト単位で指定します。 呼び出し元のアプリケーションで pClientInterfaceInfo に NULL が指定されている場合、呼び出し元のアプリケーションでは、このパラメーターに 0 を指定する必要があります。
[in, optional] lpwsDLLPath
指定したトランスポートのルーター マネージャー DLL の名前を指定する null で終わる Unicode 文字列へのポインター。 この名前を指定すると、このトランスポートの DLL パスがこの名前に設定されます。
このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。
[out] phRouterTransport
へのポインター
dwTransportId パラメーターに示されているトランスポート構成ハンドルの種類を受け取る HANDLE 変数。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
値 | 説明 |
---|---|
|
hMprConfig パラメーターが NULL であるか、phRouterTransport パラメーターが NULL であるか、両方が NULL です。 |
|
操作を完了するためのリソースが不足しています。 |
|
FormatMessage を使用して、返されるエラー コードに対応するシステム エラー メッセージを取得します。 |
解説
指定したトランスポートが既に存在する場合、 MprConfigTransportCreate は、指定されたパラメーター値を使用して MprConfigTransportSetInfo 呼び出しと同等の処理を行います。
要件
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | mprapi.h |
Library | Mprapi.lib |
[DLL] | Mprapi.dll |