FireDAC.Comp.Client.TFDCustomConnection.GetInfoReport

• Up to Parent: TFDCustomConnection

Delphi

function GetInfoReport(AList: TStrings;
AItems: TFDInfoReportItems = [riConnDef .. riKeepConnected]): TFDInfoReportStatus;

C++

TFDInfoReportStatus __fastcall GetInfoReport(System::Classes::TStrings* AList, TFDInfoReportItems AItems = (TFDInfoReportItems() << Firedac_Comp_Client__2::riConnDef << Firedac_Comp_Client__2::riFireDAC << Firedac_Comp_Client__2::riClientLog << Firedac_Comp_Client__2::riClient << Firedac_Comp_Client__2::riSessionHints << Firedac_Comp_Client__2::riSession << Firedac_Comp_Client__2::riTryConnect << Firedac_Comp_Client__2::riKeepConnected ));

Properties

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

Description

Populates a string list with a detailed report about the connection status. Use the GetInfoReport method to get the detailed report about the connection status. The report consists of the optional sections controlled by the AItems parameter:

Flag	Section header	Description
riConnDef	Connection definition parameters	The complete list of a connection definition parameters.
riFireDAC	FireDAC info	The detailed information about the FireDAC build, including version number, tool version, defines, Unicode mode.
riClientLog	Client info	The DBMS client loading log. When loading fails, then it includes the failure error message.
riClient	Client info	The detailed information about a DBMS client, when FireDAC successfully loaded the client. Otherwise--failure error message.
riSessionHints	Session info	The possible incompatibilities between FireDAC, DBMS client, and DBMS server, when the connection is active or the riTryConnect parameter is True and the connection is successfully established.
riSession	Session info	The detailed information about a DBMS session, when the connection is active or the riTryConnect parameter is True and the connection is successfully established. Otherwise--"not connected" or failure error message.

  The connection handling mode can be specified by the AItems parameter:

Flag	Description
riTryConnect	When the connection is inactive, FireDAC tries to establish a connection.
riKeepConnected	When the connection was inactive and FireDAC established it, FireDAC, on GetInfoReport exiting, will keep it active. Otherwise the connection will be closed.

  The report is put into an AList string list. Applications can use this method to:

• Test connection to a DBMS.
• Report on the DBMS environment.
• Report failures.

See DBMS Environment Reports for detailed information about this method.

See Also

• DBMS Environment Reports
• FireDAC.Comp.Client.TFDCustomConnection.Connected