Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTSession::StartDatabaseEngine

Starts the FairCom DB database engine .dll model.

Declaration

CTDBRET CTSession::StartDatabaseEngine(void)

Description

A developer can call CTSession::StartDatabaseEngine() once before calling any c-treeDB methods, and then call function CTSession::StopDatabaseEngine() when finished with database activites to shutdown the database engine. CTSession::StartDatabaseEngine() must be called before any other c-treeDB methods are performed. CTSession::StartDatabaseEngine() loads the ctsrvr.cfg configuration file, creates the data and index caches, and initializes the multithreading subsystem.

Note that automatic recovery takes place on startup which can result in short delays after making this call, especially if the process was interrupted previously and an application shutdown without calling CTSession::StopDatabaseEngine().

This is a static method and it can be invoked without the presence of a CTSession object.

Returns

StartDatabaseEngine() returns CTDBRET_OK on success, or throws a c-treeDB exception on failure.

See also

CTSession::StopDatabaseEngine(), CTSession::SetConfigurationFile()

TOCIndex