Fungsi SetIpForwardEntry2

Artikel
03/08/2023

Fungsi SetIpForwardEntry2 mengatur properti entri rute IP di komputer lokal.

Sintaks

NETIOAPI_API SetIpForwardEntry2(
  _In_ const MIB_IPFORWARD_ROW2 *Route
);

Parameter

Rute [in]
Penunjuk ke entri struktur MIB_IPFORWARD_ROW2 untuk entri rute IP. Driver Anda harus mengatur anggota DestinationPrefix dari 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 dari MIB_IPFORWARD_ROW2.

Nilai hasil

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, anggota DestinationPrefix dari struktur MIB_IPFORWARD_ROW2 yang dituju parameter Rute tidak ditentukan, anggota NextHop dari struktur MIB_IPFORWARD_ROW2 tidak ditentukan, atau anggota InterfaceLuid dan InterfaceIndex dari 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 anggota InterfaceLuid atau InterfaceIndex dari struktur MIB_IPFORWARD_ROW2 yang dituju parameter Rute .
Lainnya	Gunakan fungsi FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

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 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 anggota Metrik dari struktur MIB_IPFORWARD_ROW2 yang ditunjukkan parameter Rute 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 anggota Metrik dari struktur MIB_IPINTERFACE_ROW antarmuka terkait. Driver dapat mengambil metrik antarmuka dengan memanggil fungsi GetIpInterfaceEntry.

SetIpForwardEntry2 mengabaikan anggota Usia dan Asal dari struktur MIB_IPFORWARD_ROW2 yang ditunjuk oleh parameter Baris . Anggota ini diatur oleh tumpukan jaringan dan tidak dapat diubah dengan menggunakan fungsi SetIpForwardEntry2 .

Fungsi SetIpForwardEntry2 gagal jika anggota DestinationPrefix dan NextHop dari struktur MIB_IPFORWARD_ROW2 yang dituju parameter Rute 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)
Pustaka	Netio.lib
IRQL	< DISPATCH_LEVEL