db_stop_database function

Syntax

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

Parameters

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"

Returns

Remarks

Stop the database identified by DatabaseName (DBN) on the server identified by ServerName (Server). If ServerName is not specified, the default server is used.

By default, this function does not stop a database that has existing connections. If Unconditional (UNC) is set to yes, the database is stopped regardless of existing connections.

A return value of TRUE indicates that there were no errors.

The permission required to start and stop a database is set on the server command line using the -gd option.