MprConfigInterfaceTransportSetInfo 関数 (mprapi.h)
MprConfigInterfaceTransportSetInfo 関数は、指定されたインターフェイスとトランスポート プロトコル上のクライアントの構成情報を更新します。
構文
DWORD MprConfigInterfaceTransportSetInfo(
[in] HANDLE hMprConfig,
[in] HANDLE hRouterInterface,
[in] HANDLE hRouterIfTransport,
[in, optional] LPBYTE pInterfaceInfo,
[in, optional] DWORD dwInterfaceInfoSize
);
パラメーター
[in] hMprConfig
ルーター構成を処理します。 MprConfigServerConnect を呼び出して、このハンドルを取得します。
[in] hRouterInterface
情報を更新するインターフェイス構成を処理します。 MprConfigInterfaceCreate または MprConfigInterfaceEnum を呼び出して、このハンドルを取得します。
[in] hRouterIfTransport
クライアントの情報を更新するトランスポート構成を処理します。 MprConfigInterfaceTransportAdd、MprConfigInterfaceTransportGetHandle、または MprConfigInterfaceTransportEnum を呼び出して、このハンドルを取得します。 サポートされているトランスポート プロトコルの種類は、「 トランスポート識別子」に一覧表示されます。
[in, optional] pInterfaceInfo
指定したインターフェイスとトランスポート上のクライアントの構成情報を含む情報ヘッダーへのポインター。 この情報は、指定されたトランスポートのルーター マネージャーによって解釈されます。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。
このパラメーターは省略可能です。 呼び出し元のアプリケーションでこのパラメーターに NULL が 指定されている場合、関数はクライアントの構成情報を更新しません。
[in, optional] dwInterfaceInfoSize
pInterfaceInfo が指すデータのサイズをバイト単位で指定します。
このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに 0 を指定できます。 ただし、 pInterfaceInfo が NULL でない場合、このパラメーターを 0 にすることはできません。 詳細については、このトピックで後述する「解説」を参照してください。
戻り値
関数が成功した場合、戻り値はNO_ERROR。 詳細については、このトピックで後述する「解説」を参照してください。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
以下のうち少なくとも 1 つが true です。
|
|
hRouterInterface で指定されたインターフェイスがルーター構成に存在しないか、hRouterInterface で指定されたトランスポートがインターフェイスに存在しなくなりました。 |
|
FormatMessage を使用して、返されたエラー コードに対応するシステム エラー メッセージを取得します。 |
解説
pInterfaceInfo パラメーターが NULL の場合、MprConfigInterfaceTransportSetInfo は何も実行せず、NO_ERRORの値を指定して直ちにを返します。
要件
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mprapi.h |
| Library | Mprapi.lib |
| [DLL] | Mprapi.dll |
関連項目
MprConfigInterfaceTransportEnum