c-treeDB API for C++ - Developers Guide

CTTable Methods

Constructor / Destructor

CTTable(): Creates a CTTable object
~CTTable(): Destroys a CTTable Object and resets all the dependent objects

Table Handling

Alter(): Performs alter table functions
Close(): Closes a table
Create(): Creates a new table
GetCreateMode(): Retrieves the table create mode.
GetDataDefaultExtentSize(): Retrieves the c-tree data file default extent size
GetDataExtension(): Retrieves the data file name extension.
GetDatno(): Retrieve the table data file number.
GetGroupid(): Retrieves the table group id
GetIndexDefaultExtentSize(): Retrieves the c-tree index file default extent size
GetIndexExtension(): Retrieves the index file name extension.
GetIdxno(): Retrieve a table index file number.
GetName(): Retrieves the table name, without the name extension.
GetOpenMode(): Retrieves the table open mode.
GetPassword(): Retrieves the table password
GetPath(): Retrieves the table path.
GetPermission(): Retrieves the table permission mask
HasNullFieldSupport(): Indicates if a table has null field support
HasDelField(): Indicates if a table has delete field support.
HasLocks(): Indicates if a table has locks in the current session.
IsActive(): Indicates if a table is open or closed.
Open(): Opens an existing table
ResetAll(): Resets all active record buffers associated with the table
SetDataDefaultExtentSize(): Sets the c-tree data file default extent size
SetDataExtension(): Sets the table data file extension
SetGroupid(): Sets the table groupid
SetIndexDefaultExtentSize(): Sets the c-tree index file default extent size
SetIndexExtension(): Sets the table index file extension.
SetPassword(): Sets the table password
SetPath(): Sets the table path
SetPermission(): Sets the table permission mask
UnlockTable(): Unlocks all record locks from the table.
UpdateCreateMode(): updates the table create mode

Field Handling

AddField(): Adds a new field to table
DelField(): Deletes one field from the table.
GetField(): Retrieves a field by its number or name.
GetFieldCount(): Retrieves the number of fields in table.
GetFieldNumber(): Retrieves the field number from a field name.
GetPadChar(): Retrieves the table pad and field delimiter characters.
InsertField(): Inserts a new field to table, in the specified position.
MoveField(): Moves the field from one position to a new position in the table.
SetPadChar(): Set the table pad and field delimiter characters.
UpdatePadChar(): Update the table pad and delimiter character resource.

Filter Handling

FilterRecord(): Sets the filtering for a table.
GetFilter(): Retrieves the filter that is filtering the table.
IsFilteredRecord(): Indicates if the table is being filtered or not.

Index Handling

AddIndex(): Adds a new index to the table
DelIndex(): Deletes an index from a table
GetCndxIndex(): Retrieves the conditional index expression string, given the index number.
GetCndxIndexByName(): Retrieves the conditional index expression string, given the index name.
GetCndxIndexLength(): Retrieves the length in bytes of the conditional expression string, given the index number.
GetCndxIndexLengthByName(): Retrieves the length in bytes of the conditional expression string, given the index name.
GetIndex(): Retrieves an index object
GetIndexByUID(): Retrieves the index given its UID
GetIndexCount(): Retrieves the number of indexes of the table
HasRecbyt(): Indicates if a table was created with support to a recbyt index
HasRowid(): Indicates if a table was created with support to a rowid index

Segment Handling

AddSegment(): Adds a new segment to an index
DelSegment(): Deletes an existing segment
GetSegment(): Retrieves an index segment object
InsertSegment(): Inserts a new segment