db_start_engine function

unsigned int db_start_engine( SQLCA * sqlca, char * parms );

sqlca A pointer to a SQLCA structure.

parms A null-terminated string containing a semicolon-delimited list of parameter settings, each of the form KEYWORD=value. For example:

"UID=DBA;PWD=sql;DBF=c:\\db\\mydatabase.db"

Non-zero if successful; 0 otherwise.

Starts the database server if it is not running.

If the database server was already running or was successfully started, the return value is TRUE (non-zero) and SQLCODE is set to 0. Error information is returned in the SQLCA.

The following call to db_start_engine starts the database server, loads the specified database, and names the server demo.

db_start_engine( &sqlca, "DBF=demo.db;START=dbeng12" );

Unless the ForceStart (FORCE) connection parameter is used and set to YES, the db_start_engine function attempts to connect to a server before starting one, to avoid attempting to start a server that is already running.

When the ForceStart connection is set to YES, there is no attempt to connect to a server before trying to start one. This enables the following pair of commands to work as expected:

Start a database server named server_1:
dbeng12 -n server_1 demo.db

Force a new server to start and connect to it:

db_start_engine( &sqlda, 
  "START=dbeng12 -n server_2 mydb.db;ForceStart=YES" )

If ForceStart (FORCE) is not used and the ServerName (Server) parameter is not used, then the second command would have attempted to connect to server_1. The db_start_engine function does not pick up the server name from the -n option of the StartLine (START) parameter.

db_start_engine function

Syntax

Parameters

Returns

Remarks

See also