次の方法で共有

RtmUpdateAndUnlockRoute 関数 (rtmv2.h)

  • [アーティクル]

RtmUpdateAndUnlockRoute 関数は、宛先のルートセット内のルートの位置を更新し、宛先に最適なルート情報を調整します。

この関数は、クライアントがルートをロックして直接更新した後に使用されます ( インプレース更新とも呼ばれます)。

構文

DWORD RtmUpdateAndUnlockRoute(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [in]  ULONG                   TimeToLive,
  [in]  RTM_ROUTE_LIST_HANDLE   RouteListHandle,
  [in]  RTM_NOTIFY_FLAGS        NotifyType,
  [in]  RTM_NOTIFY_HANDLE       NotifyHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントを処理します。

[in] RouteHandle

変更するルートを処理します。

[in] TimeToLive

ルートの有効期限が切れる時間をミリ秒単位で指定します。 ルートの有効期限が切れないようにするには、INFINITE を指定します。

[in] RouteListHandle

ルートを移動するオプションのルート リストを処理します。 このパラメーターは省略可能であり、 NULL に設定できます。

[in] NotifyType

このパラメーターを NULL に設定 します。 NotifyType は、今後使用するために予約されています。

[in] NotifyHandle

このパラメーターを NULL に設定 します。 NotifyHandle は、今後使用するために予約されています。

[out] ChangeFlags

最適なルートが変更された場合は、RTM_ROUTE_CHANGE_BESTを受信します。

戻り値

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

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

値 意味
ERROR_ACCESS_DENIED
 呼び出し元のクライアントはこのルートを所有していません。

注釈

この関数を呼び出す前に、クライアントは RtmLockRoute を使用してルートをロックする必要があります。これは、ルートへのポインターを返します。 その後、クライアントは ポインターを使用してルート情報を更新できます。 最後に、クライアントは RtmUpdateAndUnlockRoute を呼び出す必要があります。 関数が正常に実行されると、ルートのロックが解除されます。 呼び出しに失敗した場合、クライアントは LockRoute パラメーターを FALSE に設定して RtmLockRoute を呼び出してルートのロックを解除する必要があります。

この関数を使用するサンプル コードについては、「 RtmUpdateAndUnlockRoute を使用してルートインプレースを更新する」を参照してください。

要件

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

こちらもご覧ください

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmGetRoutePointer

RtmHoldDestination

RtmLockRoute