Fungsi RtmGetListEnumRoutes (rtmv2.h)

Artikel
03/01/2024

Fungsi RtmGetListEnumRoutes menghitung serangkaian rute dalam daftar rute tertentu.

Sintaks

DWORD RtmGetListEnumRoutes(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumRoutes,
  [out]     PRTM_ROUTE_HANDLE RouteHandles
);

Parameter

[in] RtmRegHandle

Tangani ke klien yang diperoleh dari panggilan sebelumnya ke RtmRegisterEntity.

[in] EnumHandle

Tangani ke daftar rute untuk menghitung.

[in, out] NumRoutes

Pada input, NumRoutes adalah penunjuk ke nilai UINT yang menentukan jumlah maksimum rute yang dapat diterima oleh RouteHandles.

Pada output, NumRoutes menerima jumlah rute aktual yang diterima oleh RouteHandles.

[out] RouteHandles

Pada input, DestInfo adalah penunjuk ke array struktur RTM_DEST_INFO .

Pada output, DestInfo diisi dengan informasi tujuan yang diminta.

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	Nilai yang diarahkan oleh NumRoutes lebih besar dari jumlah maksimum rute yang diizinkan untuk diambil klien dengan satu panggilan. Periksa RTM_REGN_PROFILE jumlah maksimum rute yang diizinkan untuk diambil klien dengan satu panggilan.

Keterangan

Panggil fungsi ini berulang kali untuk mengambil semua rute.

Tidak ada lagi rute untuk dijumlahkan ketika manajer tabel perutean mengembalikan nol di NumRoutes.

Untuk kode sampel menggunakan fungsi ini, lihat Menggunakan Daftar Rute Client-Specific.

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

RtmCreateRouteListEnum

RtmDeleteEnumHandle

Bagikan melalui