Difference between revisions of "DBF ISBOF()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
Line 22: Line 22:
  
 
==DESCRIPTION==
 
==DESCRIPTION==
The DBF_ISBOF() function will return 1 if the record pointer is positioned past the first logical record of the currently selected database.  If not]], [[0 is returned or -1 if there is an error.
+
The DBF_ISBOF() function will return 1 if the record pointer is positioned past the first logical record of the currently selected database.  If not, 0 is returned or -1 if there is an error.
  
  

Latest revision as of 10:30, 30 March 2009

PURPOSE

Is record pointer at beginning of file.


SYNONYM

api_dbf_isbof()


SYNOPSIS

#include "dbapi.h"
 
int	DBF_ISBOF()
 
<input parameters>
none
 
<output parameters>
none


DESCRIPTION

The DBF_ISBOF() function will return 1 if the record pointer is positioned past the first logical record of the currently selected database. If not, 0 is returned or -1 if there is an error.


EXAMPLE

The following example returns the current position of the record pointer.

#include "dbapi.h"
 
dbapi_dbf_isbof()
{
	if (DBF_ISBOF()) {
		_retc( "BOF" );
	} else if (DBF_ISEOF()) {
		_retc( "EOF" );
	} else {
		_retc( "INF" );
	}
}


SEE ALSO

DBF_FETCH(), DBF_GOTO(), DBF_ISEOF(), DBF_LOCKR(), DBF_RECCOUNT(), DBF_RECNO(), DBF_SEEK(), DBF_SELECT(), DBF_SKIP(), DBF_UNLOCKR()