Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbSystemFilterOff

Deletes a permanent system-wide record filter.

DECLARATION

CTDBRET ctdbDECL ctdbSystemFilterOff(CTHANDLE Handle, CTSYSFILTER mode);

DESCRIPTION

Deletes a permanent system-wide record filter. The table must be opened exclusive and the user must have file definition permission for the table. Handle is a table handle or any c-treeDB API handle that can produce a table handle, such as a record, field, index or segment handle.

For the parameter mode you must specify one of the following:

Permanent Filter Symbolic Constant

Explanation

CTSYSFILTER_READ

Indicates you are deleting a system-wide read record filter.

CTSYSFILTER_WRITE

Indicates you are deleting a system-wide write record filter.

CTSYSFILTER_READ | CTSYSFILTER_WRITE

Indicates you are deleting both a system-wide read record filter and a system-wide write record filter.

RETURN

Value

Symbolic Constant

Explanation

0

CTDBRET_OK

No error occurred.

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

EXAMPLE

/* delete a system wide filter */

if (ctdbSystemFilterOff(hTable, CTSYSFILTER_READ | CTSYSFILTER_WRITE)) != CTDBRET_OK)

printf("ctdbSystemFilterOff failed\n");

SEE ALSO

ctdbSystemFilterOn()

TOCIndex