FireDAC.Comp.Client.TFDCustomManager.CloseConnectionDef

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure CloseConnectionDef(const AName: string);

C++

void __fastcall CloseConnectionDef(const System::UnicodeString AName);

Properties

Type Visibility Source Unit Parent
procedure
function
public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomManager

Description

Closes the connections for a specified connection definition name.

Use the CloseConnectionDef method to close all connections opened by using a specified connection definition and to close all pooled connections for this connection definition. After calling CloseConnectionDef, the application can modify the connection definition parameters. 

CloseConnectionDef forcibly closes all opened connections and waits until all of them are closed. If a connection is kept by other thread and cannot be closed (e.g., Abort in BeforeDisconnec), then CloseConnectionDef hangs. 

If no connections were made for the connection definition or the connection definition does not exist, no actions are taken.

See Also