Click or drag to resize

Eof Function

Determine when end-of-file is encountered.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.08
Syntax
 FUNCTION Eof() AS LOGIC
View Source

Return Value

Type: Boolean
TRUE when an attempt is made to move the record pointer beyond the last logical record in a database file or if the database file contains no records; otherwise, FALSE.  If there is no database file open in the work area, EOF() returns TRUE.
Remarks
EOF() is a database function used to test for an end-of-file boundary condition when the record pointer is moving forward through a database file.  Any command that can move the record pointer can set EOF(). The most typical application is as a part of the <lCondition> argument of a DO WHILE construct that sequentially processes records in a database file.  Here <lCondition> would include a test for .NOT. EOF(), forcing the DO WHILE loop to terminate when EOF() returns TRUE. EOF() and Found() are often used interchangeably to test whether a SEEK, FIND, or LOCATE command failed.  With these commands, however, Found() is preferred. When EOF() returns TRUE, the record pointer is positioned at LastRec() + 1 regardless of whether there is an active filter setting or SetDeleted() is TRUE.  Further attempts to move the record pointer forward return the same result without error.  Once EOF() is set to TRUE, it retains its value until there is another attempt to move the record pointer. By default, EOF() 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 (see example below).
Examples
This example demonstrates EOF() by deliberately moving the record pointer beyond the last record:
X#
USE sales
DBGoBottom()
QOut(EOF())                        // Result: FALSE
SKIP
QOut(EOF())                        // Result: TRUE
This example uses aliased expressions to query the value of EOF() in unselected work areas:
X#
USE sales NEW
USE customer NEW
QOut(Sales->EOF())
QOut(Customer->EOF())
This example illustrates how EOF() can be used as part of a condition for sequential database file operations:
X#
USE sales INDEX custnum NEW
DO WHILE !(Sales->EOF())
        nOldCust := Sales->CustNum
        nTotalAmount := 0
        DO WHILE nOldCust = Sales->CustNum .AND. ;
                                !(Sales->EOF()
                QOut(Sales->CustNum, ;
                        Sales->Description, ;
                        Sales->SaleAmount)
                nTotalAmount += Sales->SaleAmount
                SKIP
        ENDDO
        QOut("Total amount: ", nTotalAmount)
ENDDO
See Also