FireDAC.Comp.DataSet.TFDDataSet.LocateEx

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi 

function LocateEx(const AKeyFields: string; const AKeyValues: Variant;
AOptions: TFDDataSetLocateOptions = []; ApRecordIndex: PInteger = nil): Boolean; overload; virtual;
function LocateEx(const AExpression: string;
AOptions: TFDDataSetLocateOptions = []; ApRecordIndex: PInteger = nil): Boolean; overload; virtual;

C++ 

virtual bool __fastcall LocateEx(const System::UnicodeString AKeyFields, const System::Variant &AKeyValues, TFDDataSetLocateOptions AOptions = TFDDataSetLocateOptions() , System::PInteger ApRecordIndex = (System::PInteger)(0x0))/* overload */;
virtual bool __fastcall LocateEx(const System::UnicodeString AExpression, TFDDataSetLocateOptions AOptions = TFDDataSetLocateOptions() , System::PInteger ApRecordIndex = (System::PInteger)(0x0))/* overload */;

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
 FireDAC.Comp.DataSet TFDDataSet

Beschreibung

Durchsucht die Datenmenge nach einem angegebenen Datensatz anhand der Feldwerte oder festgelegter Ausdrücke, setzt den Fokus auf diesen Datensatz und gibt dessen Index zurück.

Diese Methode ist überladen:

  • Mit der ersten überladenen LocateEx-Methode durchsuchen Sie die Datenmenge nach einem Datensatz mit den angegebenen Feldwerten und machen diesen Datensatz – sofern er gefunden wird – zum aktuellen.AKeyFields ist eine durch Semikolon getrennte Liste mit Namen von Feldern, die durchsucht werden sollen.AKeyValues ist eine Variante mit den Werten, die mit den Schlüsselfeldern verglichen werden sollen. Wenn AKeyFields einen einzelnen Feldnamen enthält, dann ist AKeyValues ein einfacher Wert. Wenn AKeyFields mehrere Feldnamen enthält, dann ist AKeyValues ein Varianten-Array, in dem die Einträge den Schlüsselfeldern entsprechen.
  • Mit der zweiten überladenen LocateEx-Methode durchsuchen Sie die Datenmenge nach einem Datensatz, der dem festgelegten Ausdruck entspricht, und machen diesen Datensatz – sofern er gefunden wird – zum aktuellen.AExpression ist ein String, der den festgelegten Ausdruck enthält, anhand dessen die Suche erfolgen soll. Der Ausdruck darf keine Aggregatfunktionen, wie SUM oder COUNT, enthalten, und dessen Auswertung muss True oder False ergeben. FireDAC unterstützt die erweiterte Ausdruckssyntax.

AOptions ist eine Menge, die optional zusätzliche Suchmodi festlegt:

Option

Beschreibung

lxoCaseInsensitive

Wenn angegeben, dann ignoriert LocateEx die Groß-/Kleinschreibung beim Vergleichen von String-Werten.

lxoPartialKey

Wenn angegeben, dann können in dem Ausdruck unvollständige Strings für den Vergleich von String-Werten angegeben werden.

lxoFromCurrent

Wenn angegeben, dann beginnt LocateEx die Suche ab dem nächsten Datensatz in der Datenmenge, ansonsten wird am Anfang begonnen.

lxoBackward

Wenn angegeben, dann sucht LocateEx rückwärts nach dem Datensatz, ansonsten erfolgt die Suche vorwärts.

lxoCheckOnly

Wenn angegeben, dann führt LocateEx Folgendes nicht aus:

  • Ändern der aktuellen Position.
  • Auslösen der Ereignisse BeforeScroll/AfterScroll.
  • Beenden des Bearbeitungsmodus.

lxoNoFetchAll

Wenn angegeben, dann wird FetchAll nicht aufgerufen. Die Suche wird in bereits abgerufenen Datensätzen durchgeführt.

Wenn ein übereinstimmender Datensatz gefunden wird, dann gibt LocateEx True zurück. Der gefundene Datensatz wird zum aktuellen, wenn lxoCheckOnly nicht angegeben ist. Die Variable, auf die von ApRecordIndex gezeigt wird, erhält den Index des gefundenen Datensatzes, wenn ApRecordIndex nicht nil ist.

Zur Optimierung der Suche kann in der Anwendung ein Clientindex eingerichtet werden. Der Index wird von LocateEx verwendet, wenn die folgenden Bedingungen zutreffen:

  • Die Indexfeldliste verfügt als Präfix über AKeyFields-Felder.
  • Der Index wurde mit der Option soNoCase erzeugt, und AOptions enthält lxoCaseInsensitive. Ansonsten wurde der Index mit der Option soNoCase erzeugt, und AOptions enthält lxoCaseInsensitive nicht.
  • Der Index ist aktiv und der aktuelle Index.

Beispiel

procedure TForm1.BtnFindClick(ASender: TObject);  
begin    
  if not CustTable.LocateEx('COMPANY', 'AMCO', [lxoCaseInsensitive]) then      
    ShowMessage('Der Kunde der Firma AMCO wurde nicht gefunden');  
end;   

procedure TForm1.BtnNextClick(ASender: TObject);  
begin    
  if not CustTable.LocateEx('COMPANY', 'AMCO', [lxoCaseInsensitive, lxoFromCurrent]) then      
    ShowMessage('Der Kunde der Firma AMCO wurde nicht gefunden');  
end;

Siehe auch

Abgerufen von „https://docwiki.embarcadero.com/Libraries/Athens/d/index.php?title=FireDAC.Comp.DataSet.TFDDataSet.LocateEx&oldid=581525“