Fungsi RtmGetEnumRoutes (rtmv2.h)

Fungsi RtmGetEnumRoutes mengambil serangkaian rute berikutnya dalam enumerasi yang ditentukan.

Sintaks

DWORD RtmGetEnumRoutes(
  [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 enumerasi rute.

[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, RouteHandles adalah penunjuk ke struktur RTM_ROUTE_INFO .

Pada output, RouteHandles menerima array handel ke rute.

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.
ERROR_NO_MORE_ITEMS	Tidak ada lagi rute untuk dijumlahkan.
ERROR_NOT_ENOUGH_MEMORY	Tidak cukup memori untuk menyelesaikan operasi ini.

 

 

Keterangan

Ketika rute tidak lagi diperlukan, lepaskan dengan memanggil RtmReleaseRoutes.

Untuk kode sampel menggunakan fungsi ini, lihat Menghitung Semua 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

RtmCreateRouteEnum

RtmDeleteEnumHandle

RtmReleaseRoutes