Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

CleanIndexXtd

Clean up any leaf node exceptions and reset high-water mark.

Short Name

CLNIDXX()

Type

Utility Function

Declaration

COUNT CleanIndexXtd(pTEXT filnam, pTEXT fileword)

Description

CleanIndexXtd() function cleans any leaf nodes of exceptional transaction marks and resets the transaction high-water mark in the header to zero. This allows a high-volume transaction-controlled index file to have its high-water mark reset without rebuilding the entire index file.

Return

This routine returns an error code, but should return NO_ERROR unless filnam does not exist. See FairCom DB Error Codes for a complete listing of valid FairCom DB error values.

Example

See the ctclntrn utility for an example of this function in use.

See also

ctclntrn utility

TOCIndex