FireDAC.Comp.Client.TFDCustomManager.GetGeneratorNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

void __fastcall GetGeneratorNames(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 generators / sequences / <how else> in a database.

Call GetGeneratorNames to retrieve a list of generators / sequences / <how else> from a database. 

AConnectionName is the connection name to use. 

ACatalogName and ASchemaName restrict generator names to the catalog and schema. 

APattern is the LIKE-pattern filtering generator names. 

AList is a TStrings descendant that receives the generator names. Any existing strings are deleted from the list before GetFieldNames adds the names of generators. 

AScopes restricts generator names to the specified scopes. 

The generator names are normalized (enclosed in quotes), if required; otherwise, they are 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 generator names.

Example

FDManager.GetGeneratorNames('myconn', '', '', 'MY%', ListBox1.Items, [osMy, osSystem]);

See Also