GetIpErrorString, fonction (iphlpapi.h)

Article
08/24/2023

La fonction GetIpErrorString récupère une chaîne d’erreur d’assistance IP.

Syntaxe

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

Paramètres

[in] ErrorCode

Code d’erreur à récupérer. Les valeurs possibles pour ce paramètre sont définies dans le fichier d’en-tête Ipexport.h .

[out] Buffer

Pointeur vers la mémoire tampon qui contient la chaîne de code d’erreur si la fonction retourne avec NO_ERROR.

[in, out] Size

Pointeur vers un DWORD qui spécifie la longueur, en caractères, de la mémoire tampon pointée vers le paramètre Buffer , à l’exclusion de la valeur null de fin (c’est-à-dire la taille de la mémoire tampon en caractères, moins un).

Valeur retournée

Retourne NO_ERROR en cas de réussite.

Si la fonction échoue, utilisez FormatMessage pour obtenir la chaîne de message correspondant à l’erreur retournée.

Notes

La fonction GetIpErrorString peut être utilisée pour récupérer une chaîne d’erreur d’assistance IP pour un code d’erreur IP. Le code d’erreur IP_STATUS transmis dans le paramètre ErrorCode est retourné dans le membre Status des structures ICMP_ECHO_REPLY, ICMP_ECHO_REPLY32 et ICMPV6_ECHO_REPLY utilisées par les fonctions ICMP et ICMPv6. Les fonctions qui utilisent ces structures incluent Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 et IcmpSendEcho2Ex.

La syntaxe de la fonction GetIpErrorString a été légèrement modifiée sur le Kit de développement logiciel (SDK) Microsoft Windows publié pour Windows Vista et versions ultérieures. Le type de données du paramètre Buffer a été modifié de PWCHAR à PWSTR.

Spécifications


Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll