IcmpCloseHandle-Funktion (icmpapi.h)

Artikel
08/24/2023

Die IcmpCloseHandle-Funktion schließt ein Handle, das durch einen Aufruf der Funktionen IcmpCreateFile oder Icmp6CreateFile geöffnet wird.

Syntax

IPHLPAPI_DLL_LINKAGE BOOL IcmpCloseHandle(
  [in] HANDLE IcmpHandle
);

Parameter

[in] IcmpHandle

Der zu schließende Handle. Dieses Handle muss durch einen Aufruf von IcmpCreateFile oder Icmp6CreateFile zurückgegeben worden sein.

Rückgabewert

Wenn das Handle erfolgreich geschlossen wurde, lautet der Rückgabewert TRUE, andernfalls FALSE. Rufen Sie die GetLastError-Funktion für erweiterte Fehlerinformationen auf.

Hinweise

Die IcmpCloseHandle-Funktion wird aus dem Icmp.dll unter Windows 2000 exportiert. Die IcmpCloseHandle-Funktion wird aus dem Iphlpapi.dll unter Windows XP und höher exportiert. Die Windows-Versionsprüfung wird nicht empfohlen, diese Funktion zu verwenden. Anwendungen, die Portabilität mit dieser Funktion für Windows 2000, Windows XP, Windows Server 2003 und höhere Windows-Versionen erfordern, sollten weder statisch mit der Datei Icmp.lib noch mit der Datei Iphlpapi.lib verknüpft werden. Stattdessen sollte die Anwendung überprüfen, ob IcmpCloseHandle im Iphlpapi.dll mit Aufrufen von LoadLibrary und GetProcAddress vorhanden ist. Andernfalls sollte die Anwendung überprüfen, ob IcmpCloseHandle im Icmp.dll mit Aufrufen von LoadLibrary und GetProcAddress vorhanden ist.

Beachten Sie, dass die include-Anweisung für die Headerdatei Iphlpapi.h vor der Headerdatei Icmpapi.h platziert werden muss.

Beispiele

Im folgenden Beispiel wird ein Handle geöffnet und geschlossen, für das ICMP-Echoanforderungen ausgegeben werden können.

#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() );
    }
}

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	icmpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll unter Windows Server 2008, Windows Vista, Windows Server 2003 und Windows XP; Icmp.dll unter Windows 2000 Server und Windows 2000 Professional