a_db_info structure

Holds the information needed to return dbinfo information using the DBTools library.

Syntax

typedef struct a_db_info {
    unsigned short      version;
    MSG_CALLBACK        errorrtn;
    MSG_CALLBACK        msgrtn;
    MSG_CALLBACK        statusrtn;
    unsigned short      dbbufsize;
    char *              dbnamebuffer;
    unsigned short      logbufsize;
    char *              lognamebuffer;
    unsigned short      mirrorbufsize;
    char *              mirrornamebuffer;
    unsigned short      collationnamebufsize;
    char *              collationnamebuffer;
    const char *        connectparms;
    a_bit_field         quiet    : 1;
    a_bit_field         page_usage : 1;
    a_sysinfo           sysinfo;
    a_table_info *      totals;
    a_sql_uint32        file_size;
    a_sql_uint32        free_pages;
    a_sql_uint32        bit_map_pages;
    a_sql_uint32        other_pages;
    a_bit_field         checksum : 1;
    a_bit_field         encrypted_tables : 1;
} a_db_info;

Members

Member

Description

version

DBTools version number.

errorrtn

Callback routine for handling an error message.

msgrtn

Callback routine for handling an information message.

statusrtn

Callback routine for handling a status message.

dbbufsize

Set the length of the database file name buffer (for example, _MAX_PATH).

dbnamebuffer

Set the pointer to database file name buffer.

logbufsize

Set the length of the transaction log file name buffer (for example, _MAX_PATH).

lognamebuffer

Set the pointer to the transaction log file name buffer.

mirrorbufsize

Set the length of the mirror file name buffer (for example, _MAX_PATH).

mirrornamebuffer

Set the pointer to the mirror file name buffer.

collationnamebufsize

Set the length of the database collation name and label buffer (the maximum size is 129 including space for the null character).

collationnamebuffer

Set the pointer to the database collation name and label buffer.

connectparms

Parameters needed to connect to the database. They take the form of connection strings, such as the following:

"UID=DBA;PWD=sql;DBF=samples-dir\demo.db"

The database server would be started by the connection string START parameter. For example:

"START=c:\SQLAny12\bin32\dbeng12.exe"

A full example connection string including the START parameter:

"UID=DBA;PWD=sql;DBF=samples-dir\demo.db;START=c:\SQLAny12\bin32\dbeng12.exe"

For a list of connection parameters, see Connection parameters.

quiet

Operate without confirming messages.

page_usage

1 to report page usage statistics, otherwise 0.

sysinfo

a_sysinfo structure. See a_sysinfo structure.

totals

Pointer to a_table_info structure. See a_table_info structure.

file_size

Size of database file.

free_pages

Number of free pages.

bit_map_pages

Number of bitmap pages in the database.

other_pages

Number of pages that are not table pages, index pages, free pages, or bitmap pages.

checksum

Global checksums enabled (a checksum on every database page) if 1, disabled if 0. See Using checksums to detect corruption.

encrypted_tables

Encrypted tables are supported if 1, disabled if 0.