Fungsi RtmLockRoute (rtmv2.h)

Artikel
03/01/2024

Fungsi RtmLockRoute mengunci atau membuka kunci rute dalam tabel perutean. Ini melindungi rute sementara klien membuat perubahan yang diperlukan pada penunjuk rute buram yang dimiliki oleh klien.

Sintaks

DWORD RtmLockRoute(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [in]  BOOL              Exclusive,
  [in]  BOOL              LockRoute,
  [out] PRTM_ROUTE_INFO   *RoutePointer
);

Parameter

[in] RtmRegHandle

Tangani ke klien yang diperoleh dari panggilan sebelumnya ke RtmRegisterEntity.

[in] RouteHandle

Tangani ke rute yang akan dikunci.

[in] Exclusive

Menentukan apakah akan mengunci atau membuka kunci rute dalam mode eksklusif (TRUE) atau bersama (FALSE).

[in] LockRoute

Menentukan apakah akan mengunci atau membuka kunci rute. Tentukan TRUE untuk mengunci rute; tentukan FALSE untuk membuka kuncinya.

[out] RoutePointer

Jika penunjuk harus dikembalikan: Pada input, RoutePointer adalah penunjuk ke NULL. Pada output, jika klien memiliki rute, RoutePointer menerima pointer ke hop berikutnya; jika tidak, RoutePointer tetap tidak berubah.

Jika handel tidak perlu dikembalikan: Pada input, RoutePointer adalah NULL.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan NO_ERROR.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.

Nilai	Makna
ERROR_ACCESS_DENIED	Klien panggilan tidak memiliki rute ini.
ERROR_INVALID_HANDLE	Handel tidak valid.

Keterangan

Jangan panggil fungsi RTMv2 lainnya sampai rute tidak terkunci oleh panggilan ke RtmLockRoute dan parameter LockRoute diatur ke FALSE, atau panggilan ke RtmUpdateAndUnlockRoute.

Saat ini, fungsi ini mengunci seluruh tujuan, bukan hanya rute.

Klien hanya dapat mengubah anggota Neighbour, PrefInfo, BelongsToViews, EntitySpecificInfo, dan NextHopsList dari struktur RTM_ROUTE_INFO .

Jika salah satu nilai ini diubah, klien harus memanggil RtmUpdateAndUnlockRoute untuk memberi tahu manajer tabel perutean tentang perubahan tersebut.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	rtmv2.h
Pustaka	Rtm.lib
DLL	Rtm.dll