The mi_get_default_database_info() function

The mi_get_default_database_info() function populates a database-information descriptor with the default database parameters.

Syntax

mi_integer mi_get_default_database_info(db_info)
   MI_DATABASE_INFO *db_info;

db_info: A pointer to a user-allocated database-information descriptor in which to store the default database parameters.

Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_get_default_database_info() function returns default database parameters into the database-information descriptor (MI_DATABASE_INFO structure) that db_info references. The database parameters include the name of the database, the user account, and the account password. The mi_open() function can use these default database parameters when it establishes a connection.

Tip: You must allocate this database-information descriptor before you call mi_get_default_database_info().

If no default value exists for a particular field, the mi_get_default_database_info() function sets string fields to a NULL-valued pointer and integer fields to 0.

The mi_get_default_database_info() function also initializes the DataBlade API when it is the first DataBlade API function in a client LIBMI application or a user-defined routine.

Server only: In a user-defined routine, mi_get_default_database_info() retrieves the same information as the mi_get_default_database_info() function.

Client only: In a client LIBMI application, you can set the application database parameters with the mi_get_default_database_info() function.

For more information about the database-information descriptor, more information about how to use the database-information descriptor, or more information about ways to interact with the session environment, see the HCL Informix® DataBlade API Programmer's Guide.

Return values

MI_OK: The function was successful.
MI_ERROR: The function was not successful.