_DBStatus( ) API Library Routine

See Also   Example

Returns status flags for the specified work area.

Syntax

int _DBStatus(int workarea)
int workarea;               /* Work area. */

Remarks

If no table is open in the specified work area, _DBStatus( ) returns a negative integer whose absolute value is a Visual FoxPro error number. The following table shows returned status flags:

Flag Setting
DB_BOF Set under the same conditions as the Visual FoxPro function BOF( ).
DB_EOF Set under the same conditions as the Visual FoxPro function EOF( ).
DB_RLOCKED Set when the current record is locked, the table is locked, or the table is open exclusively.
DB_FLOCKED Set when the table is locked or the table is open exclusively.
DB_EXCLUSIVE Set when the table is open exclusively.
DB_READONLY Set when the table is open without write access.

For more information on how to create an API library and integrate it with Visual FoxPro, see Chapter 28, Accessing the Visual FoxPro API, in the Programmer's Guide.