TDataSet.MoveBy function

Member of TDataSetpublicIn unit DB

Move the cursor position.

Declaration

pascal

function MoveBy(Distance: LongInt): LongInt

Arguments

Distance

Number of positions the cursor should be moved.

Function result

Number of positions the cursor actually moved.

Description

MoveBy moves the current record pointer with Distance positions. Distance may be a positive number, in which case the cursor is moved forward, or a negative number, in which case the cursor is moved backward. The move operation will stop as soon as the beginning or end of the data is reached. The BeforeScroll and AfterScroll events are triggered (once) when this method is called. The function returns the distance which was actually moved by the cursor.

Errors

A negative distance will result in an EDatabaseError exception on unidirectional datasets.