FireDAC.Comp.Client.TFDCustomConnection.GetStoredProcNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

void __fastcall GetStoredProcNames(const System::UnicodeString ACatalogName, const System::UnicodeString ASchemaName, const System::UnicodeString APackage, 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 stored procedures in a DB.

Call GetStoredProcNames to retrieve a list of stored procedures and functions in a DB. 

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

APackage restricts procedure names to a package. 

APattern is the LIKE-pattern filtering procedure names. 

AList is a TStrings descendant that receives the procedure names. Any existing strings are deleted from the list before GetStoredProcNames adds the names of all the procedures in a DB. 

AScopes restricts stored procedure names to the specified scopes. Applies only to non-packaged procedures. 

The stored procedure 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 connection definition, to avoid these schema and/or catalog names in procedure names.

Example

FDConnection1.GetStoredProcNames('', '', '', '', ListBox1.Items, [osMy, osSystem]);

See Also