MprConfigInterfaceSetInfo 関数 (mprapi.h)

  • [アーティクル]

MprConfigInterfaceSetInfo 関数は、指定したインターフェイスの構成を設定します。

構文

DWORD MprConfigInterfaceSetInfo(
  [in] HANDLE hMprConfig,
  [in] HANDLE hRouterInterface,
  [in] DWORD  dwLevel,
  [in] LPBYTE lpbBuffer
);

パラメーター

[in] hMprConfig

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

[in] hRouterInterface

更新されるインターフェイス構成を処理します。 MprConfigInterfaceCreate、MprConfigInterfaceGetHandle、または MprConfigInterfaceEnum を呼び出して、このハンドルを取得します。

[in] dwLevel

lpBuffer パラメーターで情報が構造化される形式を表す DWORD 値。 dwLevel で使用できる値は、次の表に示すように、0、1、2、3 です。

値 構造体の形式
0 MPR_INTERFACE_0
1 MPR_INTERFACE_1
2 MPR_INTERFACE_2
3 Windows Server 2008 以降: MPR_INTERFACE_3

[in] lpbBuffer

へのポインター
MPR_INTERFACE_0、 MPR_INTERFACE_1、
MPR_INTERFACE_2、または MPR_INTERFACE_3 構造体。 dwLevel パラメーターは、構造体の種類を示します。 この構造体の情報は、インターフェイス構成を更新するために使用されます。

戻り値

関数が成功した場合、戻り値は NO_ERROR。

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

値 意味
ERROR_INVALID_PARAMETER
 以下のうち少なくとも 1 つが true です。
  • hMprConfig が NULL です。
  • hRouterInterface が NULL です。
  • dwLevel が 0、1、2、または 3 ではありません。
  • lpBuffer が NULL です。
インターフェイスの型が ROUTER_IF_TYPE_DEDICATED または ROUTER_IF_TYPE_INTERNAL で、インターフェイスが有効になっている場合にも、このエラー コードが返されます。
ERROR_NO_SUCH_INTERFACE
 hRouterInterface に対応するインターフェイスがルーター構成に存在しません。
その他
 FormatMessage を使用して、返されたエラー コードに対応するシステム エラー メッセージを取得します。

注釈

MprAdminInterfaceSetInfo 関数は、MPR_INTERFACE_2構造体をサポートしています。 ただし、 MprConfigInterfaceSetInfo はしません。 需要ダイヤル インターフェイスに永続的な変更を加えるために、MPR_INTERFACE_2を使用して MprAdminInterfaceSetInfo を呼び出し、MPR_INTERFACE_0またはMPR_INTERFACE_1で MprConfigInterfaceSetInfo を呼び出します。

要件

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

こちらもご覧ください

FormatMessage

MprConfigInterfaceCreate

MprConfigInterfaceEnum

MprConfigInterfaceGetHandle

MprConfigServerConnect

ルーター構成関数

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