Using SQLite

Name

sqlite3_compileoption_get() — Iterate over defined compile options

Definition

const char* sqlite3_compileoption_get( int iter );

iter

An iterator index value.

Returns

A UTF-8 encoded string with the option name and optional value.

Description

This function iterates over all the build options used to compile this instance of the SQLite library. By starting with an iterator value of zero (0) and calling this function over and over with an ever-increasing iterator value, all of the defined values will be returned. If the iterator value is out of range, a NULL pointer will be returned.

Only build options that were actually given will be included. Those that assumed their default values will not be given. Generally, only ENABLE, DISABLE, OMIT, and a few other directives are included in the list. DEFAULT and MAX directives that control limits or default values are not included. Most of these values can be queried with sqlite3_limit().

If the build option is a simple Boolean, only the option name will be included. If the option requires an actual value, the option will be given as name=value. In both cases, the SQLITE_ prefix will not be included.

This function is exposed to the SQL environment as the SQL function sqlite_compileoption_get(). Note that the SQL function has no 3 in the name.

See Also

sqlite3_compileoption_used(), sqlite3_compileoption_get(), sqlite_compileoption_get() [SQL Func, Ap E]