FreeBatch

Free space allocated for multiple batches (groups of records).

Short Name

FREBAT()

Type

ISAM function

Declaration

  COUNT FreeBatch()

Description

FreeBatch() should be called when it is desired to free the space allocated by AllocateBatch() for multiple, simultaneous batches.

Ordinarily, the only time it is necessary to call FreeBatch() is when you desire to increase the number of simultaneous batches from a previous optional AllocateBatch(). In this case, you call FreeBatch() to free the buffers and then AllocateBatch() with the new upper limit on batches.

CloseISAM() will free multiple batch buffers if they have not already been freed via FreeBatch().

Return

FreeBatch() should always returns NO_ERROR (0) value. Even if FreeBatch() is called when no buffers are allocated, it will simply return a zero without attempting to free any space. See “c-tree Plus Error Codes” in the c-tree Plus Programmer’s Reference Guide for a complete listing of valid c-tree Plus error values.

Example

if (AllocateBatch(3) == 0)

          printf("Room for 3 batches\n");

          FreeBatch();

          if (AllocateBatch(7) == 0)

               printf("Room for 7 batches\n");