Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbIsBatchActive

Indicates if a batch operation is underway or not.

DECLARATION

CTBOOL ctdbDECL ctdbIsBatchActive(CTHANDLE Handle);

DESCRIPTION

ctdbIsBatchActive() indicates if a batch operation is active or not. This is equivalent to ctdbBatchMode() returning CTBATCH_NONE. Handle must be a FairCom DB API record handle associated with an opened table.

RETURNS

Value

Symbolic Constant

Explanation

0

NO

Batch operation not underway.

1

YES

Batch operation underway.

See Appendix A for a complete listing of valid c-tree Plus error values.

EXAMPLE

/* check if a batch operation is active */

if (ctdbIsBatchActive(hRecord))

printf("Batch operation underway\n");

else

printf("No batch operation\n");

SEE ALSO

ctdbBatchLoaded(), ctdbBatchLocked(), ctdbBatchMode(), ctdbBatchTotal(), ctdbEndBatch(),
ctdbInsertBatch(), ctdbNextBatch(), ctdbSetBatch()

TOCIndex