Funzione GetIpErrorString (iphlpapi.h)

Articolo
08/24/2023

La funzione GetIpErrorString recupera una stringa di errore dell'helper IP.

Sintassi

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

Parametri

[in] ErrorCode

Codice di errore da recuperare. I valori possibili per questo parametro sono definiti nel file di intestazione Ipexport.h .

[out] Buffer

Puntatore al buffer contenente la stringa del codice di errore se la funzione restituisce con NO_ERROR.

[in, out] Size

Puntatore a un DWORD che specifica la lunghezza, in caratteri, del buffer a cui punta il parametro Buffer , escluso il valore Null di terminazione, ad esempio la dimensione di Buffer in caratteri meno uno.

Valore restituito

Restituisce NO_ERROR in caso di esito positivo.

Se la funzione ha esito negativo, usare FormatMessage per ottenere la stringa del messaggio per l'errore restituito.

Commenti

La funzione GetIpErrorString può essere usata per recuperare una stringa di errore dell'helper IP per un codice di errore IP. Il codice di errore IP_STATUS passato nel parametro ErrorCode viene restituito nel membro Status del ICMP_ECHO_REPLY, ICMP_ECHO_REPLY32 e ICMPV6_ECHO_REPLY strutture usate dalle funzioni ICMP e ICMPv6. Le funzioni che usano queste strutture includono Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 e IcmpSendEcho2Ex.

La sintassi per la funzione GetIpErrorString è stata leggermente modificata in Microsoft Windows Software Development Kit (SDK) rilasciata per Windows Vista e versioni successive. Il tipo di dati per il parametro Buffer è stato modificato da PWCHAR a PWSTR.

Requisiti


Client minimo supportato	Windows XP [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	iphlpapi.h
Libreria	Iphlpapi.lib
DLL	Iphlpapi.dll