SQLITE3_VTAB_IN_FIRST(3)

NAME
sqlite3_vtab_in_first, sqlite3_vtab_in_next - Find all elements on the right-hand side of an IN constraint.

SYNOPSIS
#include <sqlite3.h>
int
sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut);
int
sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);

DESCRIPTION
These interfaces are only useful from within the xFilter() method of a virtual table implementation. The result of invoking these interfaces from any other context is undefined and probably harmful.

The X parameter in a call to sqlite3_vtab_in_first(X,P) or sqlite3_vtab_in_next(X,P) must be one of the parameters to the xFilter method which invokes these routines, and specifically a parameter that was previously selected for all-at-once IN constraint processing use the sqlite3_vtab_in() interface in the xBestIndex method. If the X parameter is not an xFilter argument that was selected for all-at-once IN constraint processing, then these routines return SQLITE_MISUSE or perhaps exhibit some other undefined or harmful behavior.

Use these routines to access all values on the right-hand side of the IN constraint using code like the following:

       for(rc=sqlite3_vtab_in_first(pList, &pVal);        rc==SQLITE_OK
    && pVal        rc=sqlite3_vtab_in_next(pList, &pVal)    ){      //
    do something with pVal    }    if( rc!=SQLITE_OK ){      // an error
    has occurred    }

On success, the sqlite3_vtab_in_first(X,P) and sqlite3_vtab_in_next(X,P) routines return SQLITE_OK and set *P to point to the first or next value on the RHS of the IN constraint. If there are no more values on the right hand side of the IN constraint, then *P is set to NULL and these routines return SQLITE_DONE. The return value might be some other value, such as SQLITE_NOMEM, in the event of a malfunction.

The *ppOut values returned by these routines are only valid until the next call to either of these routines or until the end of the xFilter method from which these routines were called. If the virtual table implementation needs to retain the *ppOut values for longer, it must make copies. The *ppOut values are protected.

IMPLEMENTATION NOTES
These declarations were extracted from the interface documentation at line 9689.

    SQLITE_API int sqlite3_vtab_in_first(sqlite3_value *pVal, sqlite3_value **ppOut);
    SQLITE_API int sqlite3_vtab_in_next(sqlite3_value *pVal, sqlite3_value **ppOut);

SEE ALSO
sqlite3_value(3), sqlite3_vtab_in(3), SQLITE_OK(3)