Функция IcmpCloseHandle (icmpapi.h)

Статья
08/24/2023

Функция IcmpCloseHandle закрывает дескриптор, открытый вызовом функций IcmpCreateFile или Icmp6CreateFile .

Синтаксис

IPHLPAPI_DLL_LINKAGE BOOL IcmpCloseHandle(
  [in] HANDLE IcmpHandle
);

Параметры

[in] IcmpHandle

Закрываемая дескриптор. Этот дескриптор должен быть возвращен вызовом IcmpCreateFile или Icmp6CreateFile.

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

Если дескриптор успешно закрыт, возвращается значение TRUE, в противном случае — FALSE. Вызовите функцию GetLastError для получения расширенных сведений об ошибке.

Функция IcmpCloseHandle экспортируется из Icmp.dll в Windows 2000. Функция IcmpCloseHandle экспортируется из Iphlpapi.dll в Windows XP и более поздних версиях. Не рекомендуется использовать эту функцию для проверки версий Windows. Приложения, требующие переносимости с этой функцией в Windows 2000, Windows XP, Windows Server 2003 и более поздних версиях Windows, не должны статически связываться с файлом Icmp.lib или Iphlpapi.lib . Вместо этого приложение должно проверка наличие IcmpCloseHandle в Iphlpapi.dll с вызовами LoadLibrary и GetProcAddress. В противном случае приложение должно проверка на наличие IcmpCloseHandle в Icmp.dll с вызовами LoadLibrary и GetProcAddress.

Обратите внимание, что директива include для файла заголовка Iphlpapi.h должна быть помещена перед файлом заголовка Icmpapi.h .

Примеры

В следующем примере открывается и закрывается дескриптор, для которого можно выдавать запросы на эхо ICMP.

#include <windows.h>
#include <iphlpapi.h>
#include <icmpapi.h>
#include <stdio.h>

#pragma comment(lib, "iphlpapi.lib")

void main()
{
    HANDLE hIcmpFile;
    BOOL bRetVal; 

    hIcmpFile = IcmpCreateFile();
    if (hIcmpFile == INVALID_HANDLE_VALUE)
      printf("IcmpCreateFile failed with error: %ld\n", GetLastError() );
    else 
    {
      printf("\tHandle created.\n");

      bRetVal = IcmpCloseHandle(hIcmpFile);
      if (bRetVal)
          printf("\tHandle was closed\n");
      else
          printf("IcmpCloseHandle failed with error: %ld\n", GetLastError() );
    }
}

Требования


Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	icmpapi.h
Библиотека	Iphlpapi.lib
DLL	Iphlpapi.dll в Windows Server 2008, Windows Vista, Windows Server 2003 и Windows XP; Icmp.dll в Windows 2000 Server и Windows 2000 Профессиональная