Fungsi RtlIpv4AddressToStringExW (ip2string.h)

Artikel
01/27/2024

Fungsi RtlIpv4AddressToStringEx mengonversi alamat IPv4 dan nomor port menjadi string dalam format standar Internet.

Sintaks

NTSYSAPI NTSTATUS RtlIpv4AddressToStringExW(
  [in]      const in_addr *Address,
  [in]      USHORT        Port,
  [out]     PWSTR         AddressString,
  [in, out] PULONG        AddressStringLength
);

Parameter

[in] Address

Alamat IPv4 dalam urutan byte jaringan.

[in] Port

Nomor port dalam format urutan byte jaringan. Parameter ini bersifat opsional.

[out] AddressString

Penunjuk ke buffer untuk menerima representasi string yang diakhiri NULL dari alamat dan port IPv4. Buffer ini harus cukup besar untuk menyimpan setidaknya INET_ADDRSTRLEN karakter. Nilai INET_ADDRSTRLEN ditentukan dalam file header Ws2ipdef.h .

[in, out] AddressStringLength

Pada input, jumlah karakter yang pas di buffer yang diacu oleh parameter AddressString , termasuk terminator NULL. Pada output, parameter ini berisi jumlah karakter yang benar-benar ditulis ke buffer yang diacu oleh parameter AddressString .

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah STATUS_SUCCESS.

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

Menampilkan kode	Deskripsi
STATUS_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika penunjuk NULL diteruskan dalam parameter AddressString atau AddressStringLength . Kesalahan ini juga dikembalikan jika panjang buffer yang ditunjukkan oleh parameter AddressString tidak cukup besar untuk menerima representasi string alamat dan port IPv4.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi RtlIpv4AddressToStringEx digunakan untuk mengonversi alamat IPv4 dan nomor port ke representasi string alamat IPv4 dalam format desimal putus-putus Internet diikuti oleh karakter titik dua dan representasi string port.

RtlIpv4AddressToStringEx adalah fungsi praktis yang tidak mengharuskan DLL Soket Windows dimuat untuk mengakses fungsi yang disediakan di Soket Windows untuk melakukan alamat IP ke konversi string.

Jika panjang buffer yang ditunjukkan oleh parameter AddressString tidak cukup besar untuk menerima representasi string alamat dan port IPv4, RtlIpv4AddressToStringEx mengembalikan ERROR_INVALID_PARAMETER dan mengatur parameter AddressStringLength ke panjang buffer yang diperlukan.

Ketika UNICODE atau _UNICODE ditentukan, RtlIpv4AddressToStringEx didefinisikan ke RtlIpv4AddressToStringExW, versi Unicode dari fungsi ini. Parameter AddressString didefinisikan ke jenis data PWSTR.

Ketika UNICODE dan _UNICODE tidak ditentukan, RtlIpv4AddressToStringEx didefinisikan ke RtlIpv4AddressToStringExA, versi ANSI dari fungsi ini. Parameter AddressString didefinisikan ke jenis data PSTR.

Struktur IN_ADDR didefinisikan dalam file header Inaddr.h .

Pustaka impor yang berisi fungsi RtlIpv4AddressToStringEx tidak disertakan dalam Kit Pengembangan Perangkat Lunak (SDK) Microsoft Windows yang dirilis untuk Windows Vista. Fungsi RtlIpv4AddressToStringEx disertakan dalam pustaka impor Ntdll.lib yang disertakan dalam Windows Driver Kit (WDK). Aplikasi juga dapat menggunakan fungsi GetModuleHandle dan GetProcAddress untuk mengambil pointer fungsi dari Ntdll.dll dan memanggil fungsi ini.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	ip2string.h (termasuk Mstcpip.h)
Pustaka	ntdll.lib
DLL	ntdll.dll