Field-Map Scripting

4.2.3.37 Locate

Locate function


Prototype:

function Locate(const KeyFields: string;

               const KeyValues: variant;

               CaseInsensitive: boolean;

               PartialKey: boolean): boolean;

Description:

Call Locate to search for a specific record in a Field-Map layer and to position the cursor on it. If you want to get an unknown value from a specific field without changing the position of the cursor, use the GetValue function instead.

Syntax:

variable := Layer.Locate(KeyFields, KeyValues, CaseInsensitive, PartialKey);


Part

Description


variable

A variable declared as a boolean


Layer

A reference to the Field-Map layer as defined in Field-Map Project Manager


KeyFields

A string containing a semicolon-delimited list of field names in which to search


KeyValues

A variant array containing the values to match in the KeyFields. If KeyFields lists a single field, KeyValues specifies the value for that field on the desired record. To specify multiple search values, pass a variant array as KeyValues, or construct a variant array on the fly using the VarArrayOf routine


CaseInsensitive

Use CaseSensitive to indicate whether strings in the list should be compared in a case-sensitive (True) or case-insensitive (False) manner,


PartialKey


Return value:

True / False



See also:

Value; ValueAsString; ValueAsinteger; ValueAsFloat; ValueAsboolean; OldValue; PreviousValue; BOF; EOF; RecordCount; State; SetValues; SetValuesFromXML; CrownProjection; CrownProfile; CrownProfilePoints; StemProfile; OldLayer; SavePosition; RestorePosition; SaveState; RestoreState; SavePositionAndState; RestorePositionAndState; Open; Close; First; Last; Next; Prior; Edit; Post; Append; Delete; Cancel; Refresh; Locate; ClearTable; Filter; Filtered; CheckFilter; SetFilterExt; ClearFilterForChildLayers; DeepFilter; EnableCachedUpdates; ApplyUpdates; GetAttributeValue; GetQueryResult; DeleteFrom; Update; CreateMemTable; SaveToDBF; SaveToExcel; GetMinOfAttributeValues; GetMaxOfAttributeValues; GetMeanOfAttributeValues; GetSumOfAttributeValues; GetRecordCount; GetLookupTable; GetLookupListValue; GetLookupListAttributeValue; GetID; GetIdAttributeName; GetIdSQL; SaveTimeStamp; File2Blob; Blob2Folder; String2Blob; Blob2String; FillAttributeValues; MarkValuesAsConditional;GetListOfChildLayers; GetPercentageOfFilledAttributes4Record; GetPercentageOfFilledAttributes4Layer; RoundAttributeValues