Функция GetIpErrorString (iphlpapi.h)

Статья
08/24/2023

Функция GetIpErrorString извлекает строку ошибки вспомогательного IP-адреса.

Синтаксис

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

Параметры

[in] ErrorCode

Код ошибки, который требуется получить. Возможные значения для этого параметра определяются в файле заголовка Ipexport.h .

[out] Buffer

Указатель на буфер, содержащий строку кода ошибки, если функция возвращает с NO_ERROR.

[in, out] Size

Указатель на DWORD , указывающий длину буфера в символах, на который указывает параметр Buffer , за исключением завершающего значения NULL (т. е. размер буфера в символах, минус единица).

Возвращаемое значение

Возвращает NO_ERROR при успешном выполнении.

Если функция завершается сбоем, используйте FormatMessage , чтобы получить строку сообщения для возвращаемой ошибки.

Функцию GetIpErrorString можно использовать для получения строки ошибки вспомогательного IP-адреса для кода ошибки IP. Код ошибки IP_STATUS , переданный в параметре ErrorCode , возвращается в элементе Statusструктур ICMP_ECHO_REPLY, ICMP_ECHO_REPLY32 и ICMPV6_ECHO_REPLY , используемых функциями ICMP и ICMPv6. К функциям, которые используют эти структуры, относятся Icmp6ParseReplies, Icmp6SendEcho2, IcmpParseReplies, IcmpSendEcho, IcmpSendEcho2 и IcmpSendEcho2Ex.

Синтаксис функции GetIpErrorString был немного изменен в пакете sdk microsoft Windows, выпущенном для Windows Vista и более поздних версий. Тип данных для параметра Buffer был изменен с PWCHAR на PWSTR.

Требования


Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	iphlpapi.h
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll