Fungsi RtmCreateEnumerationHandle

[API ini telah digantikan oleh Api Manajer Tabel Perutean Versi 2 dan tidak akan tersedia di luar Windows Server 2003. Aplikasi harus menggunakan API Manajer Tabel Perutean Versi 2.]

Fungsi RtmCreateEnumerationHandle mengembalikan handel untuk digunakan dengan RtmEnumerateGetNextRoute untuk memindai semua rute, atau subset rute, yang diketahui oleh manajer tabel perutean.

Sintaks

HANDLE RtmCreateEnumerationHandle(
  _In_ DWORD ProtocolFamily,
  _In_ DWORD EnumerationFlags,
  _In_ PVOID CriteriaRoute
);

Parameter

ProtocolFamily [in]

Menentukan keluarga protokol rute yang akan dijumlahkan.

EnumerationFlags [in]

Menentukan rute mana yang harus dijumlahkan. Parameter ini membatasi kumpulan rute yang dikembalikan oleh API enumerasi ke subset yang ditentukan oleh bendera berikut dan nilai dalam anggota struktur yang sesuai yang diarahkan oleh parameter CriteriaRoute . Parameter ini bisa menjadi salah satu nilai berikut.

EnumerasiFlags	Makna
RTM_ONLY_THIS_NETWORK	Hitung hanya rute yang memiliki nomor jaringan yang sama dengan anggota RR_Network struktur yang diarahkan oleh CriteriaRoute.
RTM_ONLY_THIS_INTERFACE	Hitung hanya rute yang diperoleh melalui antarmuka yang ditentukan oleh bidang RR_InterfaceID struktur yang diarahkan oleh CriteriaRoute.
RTM_ONLY_THIS_PROTOCOL	Hitung hanya rute yang ditambahkan oleh protokol perutean yang ditentukan oleh bidang RR_RoutingProtocol struktur yang diarahkan oleh CriteriaRoute.
RTM_ONLY_BEST_ROUTES	Hitung hanya rute terbaik ke setiap jaringan dalam set.

CriteriaRoute [in]

Arahkan ke struktur rute khusus keluarga protokol (RTM_IP_ROUTE atau RTM_IPX_ROUTE). Nilai anggota dalam struktur ini sesuai dengan bendera yang ditentukan oleh parameter EnumerationFlags .

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah HANDLE untuk digunakan dengan panggilan enumerasi berikutnya.

Jika fungsi gagal, atau tidak ada rute dengan kriteria yang ditentukan, nilai yang dikembalikan adalah NULL. Hubungi GetLastError untuk mendapatkan informasi selengkapnya.

Nilai	Deskripsi
ERROR_NO_ROUTES	Tidak ada rute yang memiliki kriteria yang ditentukan.
ERROR_INVALID_PARAMETER	Satu atau beberapa parameter input tidak valid (misalnya, keluarga protokol yang tidak diketahui, bendera enumerasi yang tidak valid).
ERROR_NO_SYSTEM_RESOURCES	Tidak ada cukup sumber daya untuk melakukan operasi.
ERROR_NOT_ENOUGH_MEMORY	Memori tidak cukup untuk mengalokasikan handel.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Akhir dukungan server	Windows Server 2003
Header	Rtm.h
Pustaka	Rtm.lib
DLL	Rtm.dll

Lihat juga

Referensi Manajer Tabel Perutean Versi 1

Merutekan Fungsi Manajer Tabel Versi 1

GetLastError

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute