Função IcmpCloseHandle (icmpapi.h)
A função IcmpCloseHandle fecha um identificador aberto por uma chamada para as funções IcmpCreateFile ou Icmp6CreateFile .
Sintaxe
IPHLPAPI_DLL_LINKAGE BOOL IcmpCloseHandle(
[in] HANDLE IcmpHandle
);
Parâmetros
[in] IcmpHandle
O identificador a ser fechado. Esse identificador deve ter sido retornado por uma chamada para IcmpCreateFile ou Icmp6CreateFile.
Valor retornado
Se o identificador for fechado com êxito, o valor retornado será TRUE; caso contrário, FALSE. Chame a função GetLastError para obter informações de erro estendidas.
Comentários
A função IcmpCloseHandle é exportada do Icmp.dll no Windows 2000. A função IcmpCloseHandle é exportada do Iphlpapi.dll no Windows XP e posterior. A verificação de versão do Windows não é recomendada para usar essa função. Aplicativos que exigem portabilidade com essa função no Windows 2000, Windows XP, Windows Server 2003 e versões posteriores do Windows não devem vincular estaticamente ao arquivo Icmp.lib ou Iphlpapi.lib . Em vez disso, o aplicativo deve marcar para a presença de IcmpCloseHandle no Iphlpapi.dll com chamadas para LoadLibrary e GetProcAddress. Caso contrário, o aplicativo deve marcar para a presença de IcmpCloseHandle no Icmp.dll com chamadas para LoadLibrary e GetProcAddress.
Observe que a diretiva include para o arquivo de cabeçalho Iphlpapi.h deve ser colocada antes do arquivo de cabeçalho Icmpapi.h .
Exemplos
O exemplo a seguir abre e fecha um identificador no qual as solicitações de eco ICMP podem ser emitidas.
#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() );
}
}
Requisitos
| Cliente mínimo com suporte | Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP] |
| Servidor mínimo com suporte | Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP] |
| Plataforma de Destino | Windows |
| Cabeçalho | icmpapi.h |
| Biblioteca | Iphlpapi.lib |
| DLL | Iphlpapi.dll no Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP; Icmp.dll no Windows 2000 Server e no Windows 2000 Professional |
Confira também
IcmpSendEcho