Product Documentation

c-treeDB API for C# - Developers Guide

Previous Topic

Next Topic

CTBase.GetTableType

SYNTAX

TABLE_TYPE GetTableType( )

PARAMETERS

This method has no parameters.

DESCRIPTION

Retrieve the table type.

RETURN

The valid types are:

NONE

The table handle is not active, i.e. no table is open yet.

SESSION_DICT

The table handle is active and the table is a c-treeDB session dictionary table. The session dictionary table is a member file of ctdbdict.fsd superfile.

DATABASE_DICT

The table handle is active and the table is a c-treeDB database dictionary table. The database dictionary table is a member file of the database superfile (the file with the database name and extension .fdd).

SQL_CATALOG

The table handle is active and the table is a FairCom DB SQL catalog or system table. c-treeSQL catalog tables are members of the database superfile.

USER

The table handle is active and the table is a user created table (i.e., the table is not one of the above table types).

If the parameter Handle is NULL or not a handle that can produce a table handle, GetTableType() return NONE.

SEE ALSO

GetHandleType()

TOCIndex