MprAdminInterfaceUpdateRoutes 関数 (mprapi.h)

  • [アーティクル]

MprAdminInterfaceUpdateRoutes 関数は、指定したインターフェイスのルーティング情報を更新するように指定されたルーター マネージャーに要求します。

構文

DWORD MprAdminInterfaceUpdateRoutes(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwProtocolId,
  [in] HANDLE            hEvent
);

パラメーター

[in] hMprServer

情報が更新されているルーターを処理します。 MprAdminServerConnect を呼び出して、このハンドルを取得します。

[in] hInterface

更新されるインターフェイスを処理します。 MprAdminInterfaceCreate を呼び出して、このハンドルを取得します。

[in] dwProtocolId

ルーティング情報を更新するルーター マネージャーを指定する DWORD 値。 ルーターは、トランスポート プロトコルごとに異なるルーター マネージャーを使用します。 dwTransportId に使用できる値を次の表に示します。

値 トランスポート (プロトコル ファミリ)
PID_ATALK Appletalk
PID_IP インターネット プロトコル バージョン 4
PID_IPX インターネット パケット交換
PID_NBF NetBIOS フレーム プロトコル
PID_IPV6 Windows Server 2008 以降: インターネット プロトコル バージョン 6

[in] hEvent

指定したインターフェイスのルーティング情報の更新が完了したときに通知されるイベントを処理します。 NULL の場合、関数は同期です。 hMprServer でリモート ルーターが指定されている場合、呼び出し元のアプリケーションはこのパラメーターに NULL を指定する必要があります。

戻り値

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

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

値 意味
ERROR_ACCESS_DENIED
 呼び出し元のアプリケーションに十分な特権がありません。
ERROR_INTERFACE_NOT_CONNECTED
 指定したインターフェイスが接続されていません。 そのため、ルートを更新することはできません。
ERROR_INVALID_HANDLE
 hInterface 値が無効です。
ERROR_NO_SUCH_INTERFACE
 指定したトランスポートが、指定したインターフェイスで実行されていません。
ERROR_UNKNOWN_PROTOCOL_ID
 dwTransportId 値は、どのルーター マネージャーにも一致しません。
ERROR_UPDATE_IN_PROGRESS
 ルーティング情報の更新操作は、このインターフェイスで既に進行中です。
保留 中
 インターフェイスは、ルーティング情報を更新中です。 呼び出し元のアプリケーションは 、hEvent で指定されたイベント オブジェクトを待機する必要があります。 イベントが通知された後、 MprAdminInterfaceQueryUpdateResult を呼び出すことで、更新操作の状態を取得できます。

注釈

dwTransportId パラメーターは、トランスポート プロトコルと一意のルーター マネージャーの両方を指定します。これは、ルーターがトランスポートごとに異なるルーター マネージャーを使用するためです。

要件

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

こちらもご覧ください

MprAdminInterfaceCreate

MprAdminInterfaceQueryUpdateResult

MprAdminServerConnect

ルーター管理機能

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