MprConfigInterfaceTransportAdd 関数 (mprapi.h)
MprConfigInterfaceTransportAdd 関数は、ルーターのインターフェイス構成にトランスポート プロトコルを追加します。
構文
DWORD MprConfigInterfaceTransportAdd(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterInterface,
[in] DWORD dwTransportId,
[in, optional] LPWSTR lpwsTransportName,
[in] LPBYTE pInterfaceInfo,
[in] DWORD dwInterfaceInfoSize,
[out] HANDLE *phRouterIfTransport
);
パラメーター
[in] hMprConfig
ルーターの構成を処理します。 MprConfigServerConnect を呼び出して、このハンドルを取得します。
[in] hRouterInterface
指定したトランスポートが追加されるインターフェイス構成を処理します。 MprConfigInterfaceCreate、MprConfigInterfaceGetHandle、または MprConfigInterfaceEnum を呼び出して、このハンドルを取得します。
[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 文字列へのポインター。 このパラメーターが指定されておらず、トランスポートが IP または IPX の場合、 MprConfigInterfaceTransportAdd は IP または IPX を使用します。 このパラメーターを指定せず、トランスポートが IP または IPX 以外の場合、 MprConfigInterfaceTransportAdd は dwTransportId パラメーターを文字列に変換し、トランスポート名として使用します。
[in] pInterfaceInfo
指定したインターフェイスとトランスポートの情報を含む情報ヘッダーへのポインター。 指定されたトランスポートのルーター マネージャーは、この情報を解釈します。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。
[in] dwInterfaceInfoSize
pInterfaceInfo によって指されるデータのサイズをバイト単位で指定します。
[out] phRouterIfTransport
へのポインター
dwTransportId パラメーターに示されているこのインターフェイスのトランスポート構成ハンドルの種類を受け取る HANDLE 変数。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
次のいずれかが当てはまります。
|
|
操作を完了するためのリソースが不足しています。 |
|
FormatMessage を使用して、返されるエラー コードに対応するシステム エラー メッセージを取得します。 |
解説
トランスポートを指定するだけでなく、 dwTransportId パラメーターはルーター マネージャーも指定します。これは、ルーターがトランスポートごとに一意のルーター マネージャーを保持するためです。
指定したトランスポートが既に存在する場合、 MprConfigInterfaceTransportAdd は、指定されたパラメーター値を使用して MprConfigInterfaceTransportSetInfo 呼び出しと同等の呼び出しを行います。
要件
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |