c-treeDB API for C++ - Developers Guide

CTBase Methods

Constructor / Destructor

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

Error Handling

• GetError(): Returns the error code associated with the handle
• SetError(): Sets the error code
• ClearError(): Resets the error code

Transaction Processing

• IsTransActive(): Indicates if a transaction has been started with a call to Begin(), but not terminated with a call to Commit or Abort.
• Begin(): Begins a transaction.
• Commit(): Commits a transaction started with a call to Begin().
• Abort(): Aborts a transaction started with a call to Begin().
• SetSavePoint(): Sets a new transaction save point.
• RestoreSavePoint(): Restores a previously set save point.
• Lock(): Enables or disable record locks, using one of the c-tree lock modes
• Unlock(): Disables record locks

Handle

• GetHandle(): Returns the handle
• GetHandleId(): Returns the handle ID
• SetHandle(): Sets the handle

Type Definition

• GetDefFloatFormat(): Retrieves the default floating point string format to be used in sprintf() and sscanf()
• GetDefDateType(): Retrieves the default date type
• GetDefTimeType(): Retrieves the default time type
• SetDefFloatFormat(): Sets the default floating point string format to be used in sprintf() and sscanf()
• SetDefDateType(): Sets the default date type
• SetDefTimeType(): Sets the default time type

Other

• GetAutoCommit(): Retrieves the c-treeDB auto commit mode.
• GetUserTag(): Retrieves the user tag.
• SetUserTag(): Sets the user tag.
• SwitchInstance(): Force a c-tree Plus instance switch.
• GetKeepLock(): Gets the Keep Lock mode in use.
• SetKeepLock(): Sets the Keep Lock mode in use.

See also Locking.

In This Section CTBase::CTBase CTBase::~CTBase CTBase::Abort CTBase::GetAutoCommit CTBase::Begin CTBase::ClearError CTBase::Commit CTBase::GetDefDateType CTBase::GetDefFloatFormat CTBase::GetDefTimeType CTBase::GetError CTBase::GetHandle CTBase::GetHandleId CTBase::GetKeepLock CTBase::GetLockMode CTBase::GetOperation CTBase::GetSystemConfig CTBase::GetTransactionMode CTBase::GetUserTag CTBase::IsLockActive CTBase::IsTransActive CTBase::Lock CTBase::RestoreSavePoint CTBase::SetAutoCommit CTBase::SetDefDateType CTBase::SetDefFloatFormat CTBase::SetDefTimeType CTBase::SetError CTBase::SetHandle CTBase::SetKeepLock CTBase::SetOperation CTBase::SetSavePoint CTBase::SetUserTag CTBase::SetTransactionMode CTBase::SwitchInstance CTBase::Unlock