GetIpErrorString-Funktion (iphlpapi.h)

Artikel
08/24/2023

Die GetIpErrorString-Funktion ruft eine IP-Hilfsprogrammfehlerzeichenfolge ab.

Syntax

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

Parameter

[in] ErrorCode

Der abzurufende Fehlercode. Die möglichen Werte für diesen Parameter werden in der Headerdatei Ipexport.h definiert.

[out] Buffer

Ein Zeiger auf den Puffer, der die Fehlercodezeichenfolge enthält, wenn die Funktion mit NO_ERROR zurückgibt.

[in, out] Size

Ein Zeiger auf ein DWORD , der die Länge des Puffers in Zeichen angibt, auf den der Buffer-Parameter verweist, wobei der beendende NULL-Wert (d. h. die Größe des Puffers in Zeichen, minus 1) ausgeschlossen wird.

Rückgabewert

Gibt bei Erfolg NO_ERROR zurück.

Wenn die Funktion fehlschlägt, verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die GetIpErrorString-Funktion kann verwendet werden, um eine IP-Hilfsprogrammfehlerzeichenfolge für einen IP-Fehlercode abzurufen. Der imErrorCode-Parameter übergebene IP_STATUS Fehlercode wird im Statuselement der ICMP_ECHO_REPLY-, ICMP_ECHO_REPLY32- und ICMPV6_ECHO_REPLY-Strukturen zurückgegeben, die von den Funktionen ICMP und ICMPv6 verwendet werden. Zu den Funktionen, die diese Strukturen verwenden, gehören Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 und IcmpSendEcho2Ex.

Die Syntax für die GetIpErrorString-Funktion wurde im Microsoft Windows Software Development Kit (SDK) für Windows Vista und höher geringfügig geändert. Der Datentyp für den Buffer-Parameter wurde von PWCHAR in PWSTR geändert.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	iphlpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll