Fungsi RtmHoldDestination (rtmv2.h)

Fungsi RtmHoldDestination menandai tujuan yang akan dimasukkan ke dalam status penangguhan untuk jangka waktu tertentu. Penahanan hanya terjadi jika rute terakhir untuk tujuan dalam tampilan apa pun dihapus.

Protokol perutean yang menggunakan status tahan terus mengiklankan rute terakhir hingga penangguhan berakhir, bahkan jika rute yang lebih baru tiba sementara itu. Rute ini diiklankan sebagai rute yang dihapus. Namun, rute yang lebih baru digunakan oleh protokol perutean untuk tujuan penerusan. Rute baru diiklankan saat penahanan kedaluwarsa.

Sintaks

DWORD RtmHoldDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] RTM_VIEW_SET      TargetViews,
  [in] ULONG             HoldTime
);

Parameter

[in] RtmRegHandle

Tangani ke klien yang diperoleh dari panggilan sebelumnya ke RtmRegisterEntity.

[in] DestHandle

Tangani ke tujuan untuk menandai penangguhan.

[in] TargetViews

Menentukan tampilan untuk menyimpan tujuan.

[in] HoldTime

Menentukan berapa lama, dalam milidetik, untuk menyimpan tujuan.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.

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

Nilai	Makna
ERROR_INVALID_PARAMETER	Waktu penahanan yang ditentukan adalah nol.
ERROR_INVALID_HANDLE	Handel tidak valid.

 

 

Keterangan

Semua rute dalam status penangguhan ditahan untuk semua tampilan untuk satu waktu penahanan maksimum, terlepas dari HoldTime yang ditentukan.

Untuk kode sampel menggunakan fungsi ini, lihat Menggunakan Status Hold-Down Rute.

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

Lihat juga

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmLockRoute

RtmUpdateAndUnlockRoute