FireDAC.Comp.Client.TFDCustomConnection.GetGeneratorNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

void __fastcall GetGeneratorNames(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 generators, sequences, or others in a database.

Call GetGeneratorNames to retrieve a list of generators, sequences, or others in a database. 

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 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 generator names.

Example

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

See Also