Fungsi RtmGetFirstRoute

[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 RtmGetFirstRoute mengembalikan rute pertama dari subset rute yang ditentukan dalam tabel.

Sintaks

DWORD RtmGetFirstRoute(
  _In_    DWORD ProtocolFamily,
  _In_    DWORD EnumerationFlags,
  _Inout_ PVOID Route
);

Parameter

ProtocolFamily [in]

Menentukan keluarga protokol rute yang akan diambil, misalnya, IP atau IPX.

EnumerationFlags [in]

Menentukan batas kumpulan rute yang dihapus ke subset yang ditentukan oleh bendera ini dan nilai dalam anggota struktur terkait yang diarahkan oleh parameter CriteriaRoute . Bendera sama dengan yang digunakan di RtmCreateEnumerationHandle.

Rute [masuk, keluar]

Pada input, Rute menunjuk ke struktur khusus keluarga protokol ( RTM_IP_ROUTE atau RTM_IPX_ROUTE).

Fungsi panggilan menyediakan nilai anggota untuk struktur ini. Nilai-nilai ini, bersama dengan parameter EnumerationFlags , tentukan set untuk mengembalikan rute.

Output keluar, Rute menunjuk ke rute pertama yang cocok dengan kriteria yang ditentukan.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.

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

Nilai Deskripsi
ERROR_INVALID_PARAMETER
 Salah satu parameter tidak valid.
ERROR_NO_ROUTES
 Tidak ada rute yang cocok dengan kriteria yang ditentukan.
ERROR_NO_SYSTEM_RESOURCES
 Tidak ada cukup sumber daya untuk melakukan operasi.

Keterangan

Rute dikembalikan dalam urutan berikut:

  1. Nomor jaringan
  2. Protokol perutean
  3. Pengidentifikasi antarmuka
  4. Alamat lompatan berikutnya

Fungsi ini kurang efisien daripada fungsi handel enumerasi yang sesuai, RtmEnumerateGetNextRoute.

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

Fungsi Manajer Tabel Perutean Versi 1

RtmCloseEnumerationHandle

RtmCreateEnumerationHandle

RtmEnumerateGetNextRoute

RtmGetNextRoute

  • Last updated on