Fungsi GetIpErrorString (iphlpapi.h)

Artikel
08/24/2023

Fungsi GetIpErrorString mengambil string kesalahan Pembantu IP.

Sintaks

IPHLPAPI_DLL_LINKAGE DWORD GetIpErrorString(
  [in]      IP_STATUS ErrorCode,
  [out]     PWSTR     Buffer,
  [in, out] PDWORD    Size
);

Parameter

[in] ErrorCode

Kode kesalahan yang akan diambil. Nilai yang mungkin untuk parameter ini didefinisikan dalam file header Ipexport.h .

[out] Buffer

Penunjuk ke buffer yang berisi string kode kesalahan jika fungsi kembali dengan NO_ERROR.

[in, out] Size

Penunjuk ke DWORD yang menentukan panjang, dalam karakter, dari buffer yang diacu oleh parameter Buffer , tidak termasuk null yang mengakhiri (yaitu ukuran Buffer dalam karakter, dikurangi satu).

Menampilkan nilai

Mengembalikan NO_ERROR setelah berhasil.

Jika fungsi gagal, gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi GetIpErrorString dapat digunakan untuk mengambil string kesalahan Pembantu IP untuk kode kesalahan IP. Kode kesalahan IP_STATUS yang diteruskan dalam parameter ErrorCode dikembalikan dalam anggota StatusICMP_ECHO_REPLY,ICMP_ECHO_REPLY32, dan struktur ICMPV6_ECHO_REPLY yang digunakan oleh fungsi ICMP dan ICMPv6. Fungsi yang menggunakan struktur ini termasuk Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2, dan IcmpSendEcho2Ex.

Sintaks untuk fungsi GetIpErrorString sedikit diubah pada Kit Pengembangan Perangkat Lunak (SDK) Microsoft Windows yang dirilis untuk Windows Vista dan yang lebih baru. Jenis data untuk parameter Buffer diubah dari PWCHAR ke PWSTR.

Persyaratan


Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	iphlpapi.h
Pustaka	Iphlpapi.lib
DLL	Iphlpapi.dll