Datasnap.DBClient.TCustomClientDataSet.FindKey

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

Delphi

function FindKey(const KeyValues: array of const): Boolean; virtual;

C++

virtual bool __fastcall FindKey(const System::TVarRec *KeyValues, const int KeyValues_High);

プロパティ

種類 可視性 ソース ユニット
function public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet


説明

指定されたフィールド値を持つレコードを検索します。

FindKey を呼び出すと、特定のレコードをデータセット内で検索します。KeyValues は、キー、と呼ばれるフィールド値のカンマ区切りの配列です。キーの各値は、リテラル、nil (Delphi)、NULL (C++) のいずれかになります。KeyValues で渡された値の数が、検索で使用されるインデックス内の列の数より少なかった場合、足りない値は NULL であるとされます。C++ では、KeyValues_Size は、KeyValues 配列内の最後の値のインデックスを示します。これは、キー値の数よりも 1 つ少ない数です。

検索が成功した場合、FindKey はカーソルを一致したレコード上に置き、True を返します。そうでなければ、カーソルは移動されず、FindKeyFalse を返します。

関連項目

コード サンプル