FireDAC.Comp.Client.TFDCustomConnection.GetPackageNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

void __fastcall GetPackageNames(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 TFDCustomConnection

Description

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

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

ACatalogName, ASchemaName restrict package names to the catalog and schema. 

APattern is the LIKE-pattern 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 generator names are normalized--enclosed in quotation marks, if that is required--otherwise are converted to default dictionary case. Specify MetaDefSchema, MetaDefCatalog, or both parameters in the connection definition, to avoid these schema and/or catalog names in package names.

Example

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

See Also