Fungsi SetIpForwardEntry2
Fungsi SetIpForwardEntry2 mengatur properti entri rute IP di komputer lokal.
Sintaksis
NETIOAPI_API SetIpForwardEntry2(
_In_ const MIB_IPFORWARD_ROW2 *Route
);
Parameter
-
Route [in]
Penunjuk ke entri struktur MIB_IPFORWARD_ROW2 untuk entri rute IP. Driver Anda harus mengatur DestinationPrefix anggota struktur MIB_IPFORWARD_ROW2 ke awalan dan keluarga tujuan IP yang valid, mengatur anggota NextHop MIB_IPFORWARD_ROW2 ke alamat IP dan keluarga yang valid, dan menentukan anggota InterfaceLuid atau anggota InterfaceIndex MIB_IPFORWARD_ROW2.
Mengembalikan nilai
SetIpForwardEntry2 mengembalikan STATUS_SUCCESS jika fungsi berhasil.
Jika fungsi gagal, SetIpForwardEntry2 mengembalikan salah satu kode kesalahan berikut:
| Mengembalikan kode | Deskripsi |
|---|---|
| STATUS_INVALID_PARAMETER | Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter Rute, DestinationPrefix anggota struktur MIB_IPFORWARD_ROW2 bahwa parameter Route menunjuk ke tidak ditentukan, NextHop anggota struktur MIB_IPFORWARD_ROW2 tidak ditentukan, atau InterfaceLuid dan InterfaceIndex anggota struktur MIB_IPFORWARD_ROW2 tidak ditentukan. |
| STATUS_NOT_FOUND | Antarmuka yang ditentukan tidak dapat ditemukan. Kesalahan ini dikembalikan jika fungsi tidak dapat menemukan antarmuka jaringan yang ditentukan oleh InterfaceLuid atau InterfaceIndex anggota struktur MIB_IPFORWARD_ROW2 yang dituju oleh parameter Route. |
| Lainnya | Gunakan fungsi FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan. |
Komentar
Fungsi setIpForwardEntry2 digunakan untuk mengatur properti untuk entri rute IP yang ada di komputer lokal.
Driver Anda harus menginisialisasi anggota struktur MIB_IPFORWARD_ROW2 berikut yang ditunjuk oleh parameter Baris.
DestinationPrefix
Atur ke awalan alamat dan keluarga IPv4 atau IPv6 yang valid.NextHop
Atur ke alamat dan keluarga IPv4 atau IPv6 yang valid.InterfaceLuid atau InterfaceIndex
Anggota ini digunakan dalam urutan yang tercantum sebelumnya. Jadi jika InterfaceLuid ditentukan, anggota ini digunakan untuk menentukan antarmuka. Jika tidak ada nilai yang ditetapkan untuk anggota InterfaceLuid (nilai anggota ini diatur ke nol), anggota InterfaceIndex selanjutnya digunakan untuk menentukan antarmuka.
Offset metrik rute yang ditentukan dalam Metrik anggota struktur MIB_IPFORWARD_ROW2 yang titik parameter Route untuk hanya mewakili bagian dari metrik rute lengkap. Metrik lengkap adalah kombinasi dari offset metrik rute ini yang ditambahkan ke metrik antarmuka yang ditentukan dalam metrik anggota struktur MIB_IPINTERFACE_ROW antarmuka terkait. Driver dapat mengambil metrik antarmuka dengan memanggil fungsiGetIpInterfaceEntry.
SetIpForwardEntry2 mengabaikan Age dan Origin anggota struktur MIB_IPFORWARD_ROW2 yang ditunjuk parameter Baris. Anggota ini diatur oleh tumpukan jaringan dan tidak dapat diubah dengan menggunakan fungsi setIpForwardEntry2.
Fungsi SetIpForwardEntry2 gagal jika DestinationPrefix dan NextHop anggota struktur MIB_IPFORWARD_ROW2 yang ditujukan parameter Route tidak cocok dengan entri rute IP pada antarmuka yang ditentukan.
Persyaratan
Platform target |
Universal |
Versi |
Tersedia di Windows Vista dan versi sistem operasi Windows yang lebih baru. |
Header |
Netioapi.h (termasuk Netioapi.h) |
Perpustakaan |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |