Função RasHangUpA (ras.h)

Artigo
08/25/2023

A função RasHangUp encerra uma conexão de acesso remoto. A conexão é especificada com um identificador de conexão RAS. A função libera todos os recursos RASAPI32.DLL associados ao identificador.

Sintaxe

DWORD RasHangUpA(
  [in] HRASCONN unnamedParam1
);

Parâmetros

[in] unnamedParam1

Especifica a conexão de acesso remoto a ser encerrada. Esse é um identificador retornado de uma chamada anterior para RasDial ou RasEnumConnections.

Retornar valor

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro ou um valor de Códigos de Erro de Roteamento e Acesso Remoto ou Winerror.h.

Valor	Significado
ERROR_INVALID_HANDLE	O identificador especificado em hrasconn é inválido.

Comentários

A conexão será encerrada mesmo que a chamada RasDial ainda não tenha sido concluída.

Após essa chamada, o identificador hrasconn não pode mais ser usado.

Um aplicativo não deve chamar RasHangUp e sair imediatamente. O computador de estado de conexão precisa de tempo para terminar corretamente. Se o sistema encerrar prematuramente a máquina de estado, a máquina de estado poderá falhar ao fechar corretamente uma porta, deixando a porta em um estado inconsistente. Além disso, uma tentativa imediata de usar a mesma conexão pode falhar deixando a conexão inutilizável. Uma maneira simples de evitar esses problemas é chamar Sleep(3000) depois de retornar de RasHangUp; após essa pausa, o aplicativo pode sair. Uma maneira mais responsiva de evitar esses problemas é, depois de retornar de RasHangUp, chamar RasGetConnectStatus(hrasconn) e Sleep(0) em um loop até rasGetConnectStatus retornar ERROR_INVALID_HANDLE.

Você pode chamar RasHangUp no identificador retornado por RasGetSubEntryHandle para encerrar um único link em uma conexão de vários links. No entanto, nesse caso, você não pode usar RasGetConnectStatus para determinar se o link foi encerrado; RasGetConnectStatus pode não retornar ERROR_INVALID_HANDLE mesmo que o link tenha sido encerrado com êxito.

Observação

O cabeçalho ras.h define RasHangUp como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ras.h
Biblioteca	Rasapi32.lib
DLL	Rasapi32.dll