Show: Delphi C++
Display Preferences

FireDAC.Comp.Client.TFDCustomConnection.GetKeyFieldNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure GetKeyFieldNames(const ACatalogName, ASchemaName, ATableName, APattern: string;  AList: TStrings);

C++

void __fastcall GetKeyFieldNames(const System::UnicodeString ACatalogName, const System::UnicodeString ASchemaName, const System::UnicodeString ATableName, const System::UnicodeString APattern, System::Classes::TStrings* AList);

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 key fields in a table.

Call GetKeyFieldNames to retrieve a list of primary key fields in a table. 

ACatalogName, ASchemaName, ATableName name the table whose primary field names you want added to the list. 

APattern is the LIKE-pattern filtering field names. 

AList is a TStrings descendant that receives the primary key field names. Any existing strings are deleted from the list before GetKeyFieldNames adds the names of the primary key fields in ATableName

The field names are normalized – enclosed in quotation marks, if that is required – otherwise are converted to default dictionary case.

See Also

Samples

Personal tools
In Other Languages
Previous Versions
Assistance