xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_vtab_collation.3 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.Dd December 19, 2018
2.Dt SQLITE3_VTAB_COLLATION 3
3.Os
4.Sh NAME
5.Nm sqlite3_vtab_collation
6.Nd Determine The Collation For a Virtual Table Constraint
7.Sh SYNOPSIS
8.Ft const char *
9.Fo sqlite3_vtab_collation
10.Fa "sqlite3_index_info*"
11.Fa "int"
12.Fc
13.Sh DESCRIPTION
14This function may only be called from within a call to the xBestIndex
15method of a virtual table.
16.Pp
17The first argument must be the sqlite3_index_info object that is the
18first parameter to the xBestIndex() method.
19The second argument must be an index into the aConstraint[] array belonging
20to the sqlite3_index_info structure passed to xBestIndex.
21This function returns a pointer to a buffer containing the name of
22the collation sequence for the corresponding constraint.
23