RtmLockDestination 関数 (rtmv2.h)

RtmLockDestination 関数は、ルーティング テーブル内の宛先をロックまたはロック解除します。 この関数を使用して、不透明なポインターを変更しながら宛先を保護します。

構文

DWORD RtmLockDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] BOOL              Exclusive,
  [in] BOOL              LockDest
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントへのハンドル。

[in] DestHandle

ロックする宛先を処理します。

[in] Exclusive

排他 (TRUE) モードまたは共有 (FALSE) モードで宛先をロックまたはロック解除するかどうかを指定します。

[in] LockDest

宛先をロックまたはロック解除するかどうかを指定します。 TRUE を指定して宛先をロックします。FALSE を指定してロックを解除します。

戻り値

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

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

値	意味
ERROR_ACCESS_DENIED	呼び出し元のクライアントは、この宛先を所有していません。
ERROR_INVALID_HANDLE	ハンドルが正しくありません。

 

 

注釈

この関数は、関連付けられているルートもロックします。 ロックが解除されるまで、他のクライアントは宛先と関連付けられたルートにアクセスできないため、長期間の宛先のロックは避けてください。

クライアントは、クライアントの読み取り操作中に変更を防止しながら、宛先の情報を読み取るときにもこの関数を使用できます。 この場合は、代わりに RtmGetDestInfo を 使用することを検討してください。

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

要件

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

こちらもご覧ください

RtmGetOpaqueInformationPointer