a_db_info structure

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

Syntax

typedef struct a_db_info

Members

Member name	Type	Description
bit_map_pages	a_sql_uint32	Number of bitmap pages in the database.
charcollationspecbuffer	char *	Pointer to the char collation string buffer.
charcollationspecbufsize	unsigned short	Size of charcollationspecbuffer (at least 256+1).
charencodingbuffer	char *	Pointer to the char encoding string buffer.
charencodingbufsize	unsigned short	Size of charencodingbuffer (at least 50+1).
checksum	a_bit_field	If set TRUE, global checksums are enabled (a checksum on every database page).
connectparms	const char *	Parameters needed to connect to the database. They take the form of connection strings, such as the following: "UID=DBA;PWD=sql;DBF=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=demo.db;START=c:\SQLAny12\bin32\dbeng12.exe".
dbbufsize	unsigned short	Size of dbnamebuffer (for example, _MAX_PATH).
dbnamebuffer	char *	Pointer to the database file name buffer.
encrypted_tables	a_bit_field	If set TRUE, encrypted tables are supported.
errorrtn	MSG_CALLBACK	Address of an error message callback routine or NULL.
file_size	a_sql_uint32	Size of database file (in pages).
free_pages	a_sql_uint32	Number of free pages.
logbufsize	unsigned short	Size of lognamebuffer (for example, _MAX_PATH).
lognamebuffer	char *	Pointer to the transaction log file name buffer.
mirrorbufsize	unsigned short	Size of mirrornamebuffer (for example, _MAX_PATH).
mirrornamebuffer	char *	Pointer to the mirror file name buffer.
msgrtn	MSG_CALLBACK	Address of an information message callback routine or NULL.
ncharcollationspecbuffer	char *	Pointer to the nchar collation string buffer.
ncharcollationspecbufsize	unsigned short	Size of ncharcollationspecbuffer (at least 256+1).
ncharencodingbuffer	char *	Pointer to the nchar encoding string buffer.
ncharencodingbufsize	unsigned short	Size of ncharencodingbuffer (at least 50+1).
other_pages	a_sql_uint32	Number of pages that are not table pages, index pages, free pages, or bitmap pages.
page_usage	a_bit_field	Set TRUE to report page usage statistics, otherwise FALSE. Set TRUE by dbinfo -u option.
quiet	a_bit_field	Set TRUE to operate without confirming messages. Set TRUE by dbinfo -q option.
statusrtn	MSG_CALLBACK	Address of a status message callback routine or NULL.
sysinfo	a_sysinfo	Inline a_sysinfo structure.
totals	a_table_info *	Pointer to a_table_info structure.
version	unsigned short	DBTools version number (DB_TOOLS_VERSION_NUMBER).

a_db_info structure

Syntax

Members

See also