FireDAC.Comp.Client.TFDCustomManager.GetPackageNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure GetPackageNames(const AConnectionName, ACatalogName, ASchemaName,  APattern: string; AList: TStrings; AScopes: TFDPhysObjectScopes = [osMy]; AFullName: Boolean = True);

C++

void __fastcall GetPackageNames(const System::UnicodeString AConnectionName, const System::UnicodeString ACatalogName, const System::UnicodeString ASchemaName, const System::UnicodeString APattern, System::Classes::TStrings* AList, Firedac::Phys::Intf::TFDPhysObjectScopes AScopes = (Firedac::Phys::Intf::TFDPhysObjectScopes() << Firedac::Phys::Intf::TFDPhysObjectScope::osMy ), bool AFullName = true);

Properties

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

Description

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

Call GetPackageNames to retrieve a list of packages from a DB. 

AConnectionName is the connection name to use. 

ACatalogName, ASchemaName restrict package names to the catalog and schema.   APattern is the LIKE-pattern for filtering package names. 

AList is a TStrings descendant that receives the package names. Any existing strings are deleted from the list before GetPackageNames adds the names of all the packages in a DB. 

AScopes restricts package names to the specified scopes. 

The package names are normalized (enclosed in quotes), if required; otherwise, they are converted to default database dictionary case sensitive/insensitive. Specify the MetaDefSchema and/or MetaDefCatalog parameters in the connection definition to avoid having these schema and/or catalog names in package names.

Example

FDManager.GetPackageNames('myconn', '', 'SYS', 'DBMS%', ListBox1.Items, [osMy, osSystem]);

See Also