Data.SqlExpr.TSQLConnection.GetIndexNames
| [–] Properties | |
|---|---|
| Type: procedure function
| |
| Visibility: public | |
| Source: Data.SqlExpr.pas Data.SqlExpr.hpp
| |
| Unit: Data.SqlExpr | |
| Parent: TSQLConnection | |
Delphi
procedure GetIndexNames(const TableName: string; List: TStrings); overload;
procedure GetIndexNames(const TableName, SchemaName: string; List: TStrings); overload;
C++
void __fastcall GetIndexNames(const System::UnicodeString TableName, System::Classes::TStrings* List)/* overload */;
void __fastcall GetIndexNames(const System::UnicodeString TableName, const System::UnicodeString SchemaName, System::Classes::TStrings* List)/* overload */;
Description
Populates a string list with the names of indexes on a table.
Call GetIndexNames to retrieve a list of the indexes defined for a table.
List is a TStrings descendant that receives the index names. Any existing strings are deleted from the list before GetIndexNames adds the names of all the indexes on TableName.
TableName names the table whose indexes you want added to the list.
For example, the following line fills a list box with the names of all indexes on the Employee table:
SQLConnection1.GetIndexNames('Employee', ListBox1.Items);
SQLConnection1->GetIndexNames("Employee", ListBox1->Items);