Ksqlite C API/ksqlite.capi.vtab.callbacks/SqliteVtabFilterCallback

SqliteVtabFilterCallback

fun interface SqliteVtabFilterCallback<VtabCursor : sqlite3_vtab_cursor>(source)

This method begins a search of a virtual table. The first argument is a cursor opened by xOpen. The next two arguments define a particular search index previously chosen by xBestIndex. The specific meanings of idxNum and idxStr are unimportant as long as xFilter and xBestIndex agree on what that meaning is.

The xFilter Method

Functions

apply

abstract fun apply(cursor: VtabCursor, idxNum: Int, idxStr: String?, arguments: Array<sqlite3_value>): SqliteResultCode.OkOrFailure

Details on parameters and result can be found here.