xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_bind_parameter_index.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3_BIND_PARAMETER_INDEX 3
3.Os
4.Sh NAME
5.Nm sqlite3_bind_parameter_index
6.Nd index of a parameter with a given name
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3_bind_parameter_index
11.Fa "sqlite3_stmt*"
12.Fa "const char *zName"
13.Fc
14.Sh DESCRIPTION
15Return the index of an SQL parameter given its name.
16The index value returned is suitable for use as the second parameter
17to sqlite3_bind().
18A zero is returned if no matching parameter is found.
19The parameter name must be given in UTF-8 even if the original statement
20was prepared from UTF-16 text using
21.Fn sqlite3_prepare16_v2
22or
23.Fn sqlite3_prepare16_v3 .
24.Sh IMPLEMENTATION NOTES
25These declarations were extracted from the
26interface documentation at line 4748.
27.Bd -literal
28SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
29.Ed
30.Sh SEE ALSO
31.Xr sqlite3_bind_blob 3 ,
32.Xr sqlite3_bind_parameter_count 3 ,
33.Xr sqlite3_bind_parameter_name 3 ,
34.Xr sqlite3_prepare 3
35