FireDAC.Comp.Client.TFDCustomConnection.GetSchemaNames

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: public
Source:
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
Unit: FireDAC.Comp.Client
Parent: TFDCustomConnection

Delphi

procedure GetSchemaNames(const ACatalogName, APattern: string; AList: TStrings);

C++

void __fastcall GetSchemaNames(const System::UnicodeString ACatalogName, const System::UnicodeString APattern, System::Classes::TStrings* AList);

Description

Populates a string list with the names of schemas in a DB.

Call GetSchemaNames to retrieve a list of schemas in a DB. 

ACatalogName restricts schema names to the specified catalog. If it is empty, then all schemas are returned. 

APattern is the LIKE-pattern filtering schema names. 

AList is a TStrings descendant that receives the schema names. Any existing strings are deleted from the list before GetSchemaNames adds the names of all the schemas in a DB.

Example

FDConnection1.GetSchemaNames('', '', ListBox1.Items);

See Also