The Main Manual Page Dynamic API Documentation CD-ROM API Documentation About Onix Types About Onix Errors Onix's Web Site at Lextek International Lextek International Onix Full Text Indexing and Retrieval Toolkit

ixIsRecordDeleted

NAME

ixIsRecordDeleted -- Returns whether a record has been deleted or not.

SYNOPSIS

BooleanT  ixIsRecordDeleted(OnixIndexManagerT IndexManager, RecordNumT RecordNum, StatusCodeT *Status);

ARGUMENTS

IndexManager -- An index manager created with a call to ixCreateIndexManager() which has an index open with a retrieval session in progress.

RecordNum -- The record number of the record in question.

Status -- A pointer to a value of type StatusCodeT.  If an error occurs, Status will be set to the appropriate error value.

RETURNS

BooleanTrue if the record RecordNum has been deleted, false otherwise.

DESCRIPTION

Onix allows you to delete records from the index.  (The records are actually still there but they are marked deleted internally.)  ixIsRecordDeleted returns whether a given record has been deleted or not.  If the record has been deleted, ixIsRecordDeleted returns BooleanTrue, otherwise it returns false.  It is important to note that the index which is currently open in the index manager have a retrieval session in progress.  Otherwise, this function will not work as the record numbers of the deleted records will not be loaded.

SEE ALSO

ixDeleteRecordNum, ixDeleteRecordNums, ixUnDeleteRecordNum, ixUnDeleteRecordNums, ixOutputDeletedRecords, ixGetNumberOfRecordsDeleted