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

ixOutputDeletedRecords

NAME

ixOutputDeletedRecords -- Output the record numbers of all the deleted records.

SYNOPSIS

void ixOutputDeletedRecords(OnixIndexManagerT IndexManager, RecordNumT *RecordNumArray, StatusCodeT *Status);

ARGUMENTS

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

RecordNumArray -- A pointer to an array into which the record numbers are to be placed.  Note: This assumes that the array is of adequate size to store the record numbers.

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

RETURNS

Nothing.

DESCRIPTION

ixOutputDeletedRecords outputs the record numbers of all the records which are currently deleted into an array pointed to by RecordNumArray.  To find out how large your array needs to be, make a call to ixGetNumberOfRecordsDeleted() which returns the number of records currently deleted.  Note: This function will fail if the index which is currently managed by the index manager is not open and a retrieval session is not in progress.

SEE ALSO

ixIsRecordDeleted, ixDeleteRecordNum, ixDeleteRecordNums, ixUnDeleteRecordNum, ixUnDeleteRecordNums, ixGetNumberOfRecordsDeleted