|
unsigned int db_stop_engine( SQLCA * sqlca, char * parms );
sqlca A pointer to a SQLCA structure. For information, see The SQL Communication Area (SQLCA).
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"
For a list of connection parameters, see Connection parameters.
Terminates execution of the database server. The steps carried out by this function are:
Look for a local database server that has a name that matches the EngineName (ENG) parameter. If no EngineName is specified, look for the default local database server.
If no matching server is found, this function returns with success.
Send a request to the server to tell it to checkpoint and shut down all databases.
Unload the database server.
By default, this function does not stop a database server that has existing connections. If Unconditional is yes, the database server is stopped regardless of existing connections.
A C program can use this function instead of spawning dbstop. A return value of TRUE indicates that there were no errors.
The use of db_stop_engine is subject to the permissions set with the -gk server option. See -gk server option.