Using SQLite

Name

sqlite3_compileoption_used() — Get a compile option value

Definition

int sqlite3_compileoption_used( const char* name );

name

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

Returns

A Boolean that indicates if the specified compile option and, optionally, the value was used.

Description

This function queries if a specific compile option (and, possibly, value) was used to compile this instance of the SQLite library. This function is aware of the same build options that sqlite3_compileoption_get() returns. The function will work with or without the SQLITE_ prefix.

In the case of a Boolean build option, the name should just be the build option itself. The return value will indicate if the option was used or not. In the case of build options that require an actual value, the name can either include just the name, or it can include a name-value pair in the format name=value. If just the name is given, the return value will indicate if the build option was used with any value. If the value is given, the return value will indicate if the build option was set to that specific value.

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

See Also

sqlite3_compileoption_get(), sqlite_compileoption_used() [SQL Func, Ap E]