次の方法で共有


MprConfigInterfaceTransportGetInfo 関数 (mprapi.h)

MprConfigInterfaceTransportGetInfo 関数は、指定したインターフェイス上の指定したクライアントの構成情報を取得します。

構文

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

パラメーター

[in] hMprConfig

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

[in] hRouterInterface

指定したクライアント情報の取得元となるインターフェイス構成を処理します。 MprConfigInterfaceCreateMprConfigInterfaceGetHandle、または MprConfigInterfaceEnum を呼び出して、このハンドルを取得します。

[in] hRouterIfTransport

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

[in, out, optional] ppInterfaceInfo

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

出力時に、このポインター変数は、クライアントの構成情報を含む情報ヘッダーを指します。 情報ヘッダー関数を使用して、情報ヘッダーを操作します。 MprConfigBufferFree を呼び出して、このメモリを解放します。

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

[out, optional] lpdwInterfaceInfoSize

DWORD 変数へのポインター。 この変数は、 ppInterfaceInfo が指すデータのサイズをバイト単位で受け取ります。

このパラメーターは省略可能です。呼び出し元のアプリケーションでは、このパラメーターに NULL を 指定できます。 ただし、 ppInterfaceInfoNULL でない場合、このパラメーターを NULL にすることはできません。 詳細については、このトピックで後述する「解説」を参照してください。

戻り値

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

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

説明
ERROR_INVALID_PARAMETER
次のいずれかが当てはまります。
  • hMprConfigNULL です
  • hRouterInterfaceNULL です
  • hRouterIfTransportNULL です
  • ppInterfaceInfoNULL ではありませんが、 lpdwInterfaceInfoSizeNULL です
ERROR_NO_SUCH_INTERFACE
hRouterIfTransport で指定されたインターフェイスがルーター構成で見つからないか、指定されたインターフェイスで hRouterIfTransport で指定されたトランスポートが有効になっていませんでした。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するためのリソースが不足しています。
その他
FormatMessage を使用して、返されるエラー コードに対応するシステム エラー メッセージを取得します。
 
 

解説

ppInterfaceInfo パラメーターが NULL の場合、MprConfigInterfaceTransportGetInfo は何も実行せず、NO_ERRORの値で直ちにを返します。

要件

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

関連項目

FormatMessage

MPR_IFTRANSPORT_0

MprConfigBufferFree

MprConfigInterfaceCreate

MprConfigInterfaceEnum

MprConfigInterfaceGetHandle

MprConfigInterfaceTransportEnum

MprConfigInterfaceTransportGetHandle

MprConfigServerConnect

ルーター構成関数

ルーター管理リファレンス