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

ixDeleteRecordNum

NAME

ixDeleteRecordNum -- Delete a record from the index.

SYNOPSIS

void ixDeleteRecordNum(OnixIndexManagerT IndexManager, RecordNumT RecordNum, StatusCodeT *Status);

ARGUMENTS

IndexManager -- An index manager with an open index and a retrieval session in progress.

RecordNum -- The record number of the record which is to be deleted.

Status -- A pointer to a value of type StatusCodeT.  If an error occurs *Status will be set to a negative value corresponding with the error.

RETURNS

Nothing.

DESCRIPTION

ixDeleteRecordNum deletes a record from the index.  The function deletes the record with the record number RecordNum.  This function will fail if an index is not open and a retrieval session is not in progress.  The deletion takes place immediately.  However, the deletion will not be committed to the index itself until the index is closed by a call to ixCloseIndex().

SEE ALSO

ixIsRecordDeleted, ixDeleteRecordNums, ixUnDeleteRecordNum, ixUnDeleteRecordNums, ixOutputDeletedRecords, ixGetNumberOfRecordsDeleted