Fungsi RtmRegisterEntity (rtmv2.h)

Artikel
03/15/2023

Fungsi RtmRegisterEntity mendaftarkan klien dengan instans manajer tabel perutean untuk keluarga alamat tertentu. Manajer tabel perutean mengembalikan handel pendaftaran dan profil instans. Profil berisi daftar nilai yang digunakan saat memanggil fungsi lain. Nilai mencakup jumlah maksimum tujuan yang dikembalikan dalam buffer dengan satu panggilan.

Pendaftaran adalah tindakan pertama yang harus dilakukan klien.

Sintaks

DWORD RtmRegisterEntity(
  [in]  PRTM_ENTITY_INFO           RtmEntityInfo,
  [in]  PRTM_ENTITY_EXPORT_METHODS ExportMethods,
  [in]  RTM_EVENT_CALLBACK         EventCallback,
  [in]  BOOL                       ReserveOpaquePointer,
  [out] PRTM_REGN_PROFILE          RtmRegProfile,
  [out] PRTM_ENTITY_HANDLE         RtmRegHandle
);

Parameter

[in] RtmEntityInfo

Arahkan ke struktur RTM_ENTITY_INFO . Struktur ini berisi informasi yang mengidentifikasi klien ke manajer tabel perutean, seperti instans manajer tabel perutean dan keluarga alamat yang akan didaftarkan.

[in] ExportMethods

Pointer ke struktur RTM_ENTITY_EXPORT_METHODS yang berisi daftar metode yang diekspor oleh klien. Parameter ini bersifat opsional dan dapat diatur ke NULL jika klien panggilan tidak memiliki metode untuk diekspor.

[in] EventCallback

Struktur RTM_EVENT_CALLBACK yang menentukan panggilan balik yang digunakan manajer tabel perutean untuk memberi tahu klien peristiwa. Peristiwa adalah ketika klien mendaftar dan membatalkan pendaftaran, ketika rute kedaluwarsa, dan ketika perubahan pada rute terbaik ke tujuan telah terjadi. Hanya perubahan yang ditentukan ketika klien memanggil RtmRegisterForChangeNotification.

[in] ReserveOpaquePointer

Menentukan apakah akan memesan pointer buram di setiap tujuan untuk instans protokol ini. Tentukan TRUE untuk memesan pointer buram di setiap tujuan. Tentukan FALSE untuk melewati tindakan ini. Pointer buram ini dapat digunakan untuk menunjuk ke konteks privat khusus protokol untuk setiap tujuan.

[out] RtmRegProfile

Pada input, RtmRegProfile adalah penunjuk ke struktur RTM_REGN_PROFILE .

Pada output, RtmRegProfile diisi dengan struktur profil pendaftaran yang diminta. Klien harus menggunakan informasi yang dikembalikan dalam panggilan fungsi lain (informasi yang dikembalikan mencakup jumlah hop berikutnya dengan biaya yang sama dan jumlah maksimum item yang dikembalikan oleh panggilan fungsi enumerasi).

[out] RtmRegHandle

Menerima handel pendaftaran untuk klien. Handel ini harus digunakan di semua panggilan berikutnya ke manajer tabel perutean.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan NO_ERROR.

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

Nilai	Makna
ERROR_ALREADY_EXISTS	Klien yang ditentukan telah terdaftar di manajer tabel perutean.
ERROR_BAD_CONFIGURATION	Informasi registri untuk manajer tabel perutean rusak.
ERROR_FILE_NOT_FOUND	Informasi registri untuk manajer tabel perutean tidak ditemukan.
ERROR_INVALID_DATA	Parameter berisi informasi yang salah.
ERROR_INVALID_PARAMETER	Parameter berisi informasi yang salah.
ERROR_NO_SYSTEM_RESOURCES	Tidak tersedia cukup sumber daya sistem untuk menyelesaikan operasi ini.
ERROR_NOT_ENOUGH_MEMORY	Memori tidak cukup untuk menyelesaikan operasi ini.

Keterangan

Untuk kode sampel menggunakan fungsi ini, lihat Mendaftar Dengan Manajer Tabel Perutean.

Persyaratan


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