Click or drag to resize

Functions.DbGoTop Method (Usual)

X#
Move to the first logical record.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.16
Syntax
Copy
 FUNCTION DbGoTop(
	uArea AS USUAL
) AS LOGIC
Request Example View Source

Parameters

uArea
Type: Usual
Specifies the work area name or number for a table on which the operation must be performed.

Return Value

Type: Logic
TRUE if successful; otherwise, FALSE.
Remarks
By default, this function operates on the currently selected work area. It can be made to operate on an unselected work area by specifying it within an aliased expression or by calling the overload that accepts a workarea parameter (a workarea number or alias ). DBGoTop() performs the same function as the GO TOP command.
Tip Tip
Logical records: DBGoTop() operates on logical records.
If the work area has an active order list, DBGoTop() moves to the first record in the controlling order.
If a filter is set, only records which meet the filter condition are considered. Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes.
Examples
This example demonstrates the typical use of DBGoTop():
X#
Copy
1DBGoTop()
2WHILE (!EOF())
3    QOut(_FIELD->Name)
4    DBSkip()
5END
See Also