FireDAC.Comp.DataSet.TFDDataSet.AddIndex

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

procedure AddIndex(const AName, AFields, AExpression: string; AOptions: TFDSortOptions;  const ADescFields: string = ''; const ACaseInsFields: string = ''; ADistinct: Boolean = False);

C++

void __fastcall AddIndex(const System::UnicodeString AName, const System::UnicodeString AFields, const System::UnicodeString AExpression, Firedac::Stan::Intf::TFDSortOptions AOptions, const System::UnicodeString ADescFields = System::UnicodeString(), const System::UnicodeString ACaseInsFields = System::UnicodeString(), bool ADistinct = false);

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet

説明

データセットのクライアント インデックスを新規作成します。


AddIndex を呼び出して、クライアント データセットのインデックスを新規作成します。

このメソッドは、新規インデックスを Indexes プロパティに手動で追加し、新規インデックスの各プロパティを設定することに相当します。AName という名前のインデックスが既にある場合には、例外が発生します。

AField プロパティと AExpression プロパティは、どちらか一方しか指定できません。新規インデックスはアクティブになるが、現在のインデックスにはなりません。

パラメータの意味:

  • AName - 新規インデックスの名前です。
  • AFields - インデックスに含まれる各フィールドをセミコロンで区切ったリストです。
  • AExpression - ソート式です。
  • AOptions - インデックスに対する一連の追加オプションです。
  • ADescFields - 各フィールド名をセミコロンで区切ったリストです。soDescending を含む AOptions ではなく、ADescFields を使用すると、一部のフィールドが昇順で、他のフィールドが降順であるインデックスを作成します。ADescFields で名前が指定されているすべてのフィールドは、降順でソートされます。
  • ACaseInsFields - 各フィールド名をセミコロンで区切ったリストです。soNoCase を含む AOptions 値ではなく、ACaseInsFields を使用すると、一部のフィールドでは大文字と小文字は区別されず、他のフィールドでは大文字と小文字が区別されるインデックスを作成します。ACaseInsFields で名前が指定されているすべてのフィールドは、大文字と小文字に関係なく、ソートされます。
  • ADistinct - 異なる AFields/AExpression の値があるレコードだけを取得する必要がある場合は、True です。すべてのレコードを取得する必要がある場合、False です。デフォルト値は False です。

関連項目