Exibir origem

Encerra a conexão especificada com o DBAccess.

Sintaxe

TCUnlink( [ nHandle ], [ lVerbose ] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nHandle	numérico	Indica o número da conexão que será finalizada.
lVerbose	lógico	Caso especificado .T., mostra mensagens de advertência do log de console, como por exemplo fechamento automático de alias da conexão.

Retorno

Nome	Tipo	Descrição
lRet	lógico	Retorna verdadeiro (.T.), se a conexão for encerrada com sucesso; caso contrário, falso (.F.), se houver falha de execução.

Observações

Se o parâmetro nHandle não for informado, a conexão ativa/atual será encerrada.
Geralmente, as falhas de execução ocorrem quando tentamos encerrar uma conexão informando um handler inexistente ou já fechado anteriormente.
Em um ambiente com mais de uma conexão simultânea na mesma thread realizada via TCLink (duas ou mais conexões estão ativas), o fechamento de uma coloca automaticamente a conexão aberta anteriormente como ativa.
O número da conexão é obtido no momento que a conexão é estabelecida, através da função TCLink.
Ao executar a função TCUnlink, não deve haver tabelas abertas utilizando a conexão que está sendo fechada. Caso existam, elas serão fechadas automaticamente.
O valor padrão do parâmetro lVerbose é .F. (falso).
No caso de haver algum alias aberto ao ser encerrada uma conexão através da função TCUnlink, era emitida uma mensagem de advertência no log de console do AppServer, informando que houve o fechamento automático do(s) alias relacionado(s) à conexão. A partir do release 7.00.131227A com data de geração igual ou superior a 10/02/2016, estas mensagens de advertência deixaram de ser registradas no log de console, sendo possível habilitá-las novamente apenas mediante a utilização do parâmetro lVerbose, que passa a ser considerado a partir desse release.

Exemplos

  nHnd1 := TCLink( "MSSQL/DSN1", "127.0.0.1", 7890 )
  nHnd2 := TCLink( "MSSQL/DSN2", "127.0.0.1", 7890 )
  
  ...
  
  TCUnlink( nHnd1 ) // Finaliza a conexao nHnd1
  
  ...

Veja também

TCLink