DBF DELETED()

From Recital Documentation Wiki
Revision as of 10:43, 30 March 2009 by Yvonnemilne (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

PURPOSE

Is record deleted


SYNONYM

api_dbf_isdeleted()


SYNOPSIS

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


DESCRIPTION

The DBF_DELETED() function will return the current record is flagged for deletion, 0 if it is not and -1 if there is no database open in the currently selected workarea.

Deleted records remain in the database until a PACK is performed on the database. The Recital command SET DELETED determines whether or not the record will be displayed.


EXAMPLE

The following example returns .T. is the current record is marked for deletion.

#include "dbapi.h"
 
dbapi_dbf_deleted()
{
    int	isdeleted;
 
    isdeleted = DBF_DELETED();
 
    _retl( isdeleted );
}


SEE ALSO

DBF_DELETE(), DBF_FETCH(), DBF_FILTER(), DBF_GOTO(), DBF_ISEXCLUSIVE(), DBF_ISREADONLY(), DBF_LOCKF(), DBF_LOCKR(), DBF_RECALL(), DBF_RECNO(), DBF_SKIP(), DBF_UNLOCKF(), DBF_UNLOCKR()