db_stop_database function

Prototype

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

Arguments

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.

Description

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 is 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. For information, see -gd dbeng12/dbsrv12 server option.

Discuss this page in DocCommentXchange.