View source for Data.SqlExpr.TCustomSQLDataSet.Locate

{{#lst:API:Data.SqlExpr.TCustomSQLDataSet.Locate|api}}
<!--Start API Documentation-->
==Description==
{{#ifeq: {{PAGENAME}} | Data.SqlExpr.TCustomSQLDataSet.Locate | |{{InheritsFrom|Data.SqlExpr.TCustomSQLDataSet.Locate}}}}

<section begin=short />Implements a virtual method for searching a dataset for a specified record and making it the active record.<section end=short />

The [[Data.SqlExpr.TCustomSQLDataSet.Locate|Locate]] method checks whether the dataset is unidirectional, and if so, raises an '''EDatabaseError''' exception.

Descendant classes that are not unidirectional override [[Data.SqlExpr.TCustomSQLDataSet.Locate|Locate]] so that it locates the record where the fields identified by the semicolon-separated list of fields in '''KeyFields''' have the values specified by the Variant or Variant array '''KeyValues'''. The '''Options''' parameter indicates whether the search is case insensitive and whether partial matches are supported.

[[Data.SqlExpr.TCustomSQLDataSet.Locate|Locate]] returns '''True''' if a record that matches the specified criteria and is now active is found, and '''False''' otherwise.

===See Also===

* [[Data.DB.TDataSet.FindField|FindField]]

* [[Data.DB.TDataSet.Lookup|Lookup]]


[[Category:API Documentation]]
<!--End API Documentation-->