Product Documentation

Full-Text Search

Previous Topic

Next Topic

ctdbCheckFTIBackgroundLoad

Check the status of the background index loader for the Full-Text Index (FTI).

Declaration

CTDBRET ctdbLOCAL ctdbCheckFTIBackgroundLoad(pCTDBFTI pFTI, pBGLDINF status)

Parameters

  • pFTI [IN] - Full-Text Index handle.
  • status [OUT] - Status information.

Description

Note: It is not possible to delete an FTI for which a background load has been started and still not finished. Attempting this operation causes the ctdbAlterTable() to fail with error CTDBRET_LOADISACTIVE (4166, new error code).

This function was originally named ctdbFTICheckBackgroundLoad, which has been deprecated.

Return

Value

Symbolic Constant

Explanation

0

CTDBRET_OK

Successful operation.

4165

CTDBRET_NOLOAD

The background FTI index loader has not been "started" on the specified FTI.

See c-tree Plus Error Codes for a complete listing of valid c-tree Plus error values.

See Also

TOCIndex