Sign in Join
FPDoc Onlineexperiment

TMemDataset.Locate function

Member of TMemDatasetpublicIn unit MemDs

Locates a record with the specified values in the in-memory dataset.

Declaration

pascal
function Locate(const KeyFields: string; const KeyValues: Variant; 
 Options: TLocateOptions): Boolean; override

Arguments

KeyFields

Field names to search in the method.

KeyValues

Fields values to match in the method.

Options

Search options for the locate operation.

Function result

True if a record is located with the specified values.

Description

Locate is an overridden Boolean function used to locate a record with the specified values in the specified fields. LocateOptions indicates if case-insensitivity or partial keys searches are used in the method. Locate calls the inherited method to ensure that the dataset is bi-directional. Locate calls CheckActive to ensure that the dataset has been opened prior to searching for values in record data. Locate calls MDSLocateRecord to get the return value for the method. When the return value is True, the current record for the dataset is updated and Resync is called to update the active record buffer.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.