Data.DB.TDataLink.MoveBy

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: protected
Source:
Data.DB.pas
Data.DB.hpp
Unit: Data.DB
Parent: TDataLink

Delphi

function MoveBy(Distance: Integer): Integer; virtual;

C++

virtual int __fastcall MoveBy(int Distance);

Description

Repositions the dataset to another record relative to its active record.

The MoveBy record changes the active record in the associated dataset, based on the Distance parameter. If Distance is greater than 0, MoveBy causes the dataset to move forward by that number of records. If Distance is less than 0, MoveBy causes the dataset to move backward. MoveBy returns the number of records actually moved (which may be less than the absolute value of Distance if the dataset encountered the first or last record before moving the indicated number of records).

MoveBy calls the MoveBy method of the associated dataset.

See Also