xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_bind_parameter_name.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.Dd December 19, 2018
2.Dt SQLITE3_BIND_PARAMETER_NAME 3
3.Os
4.Sh NAME
5.Nm sqlite3_bind_parameter_name
6.Nd Name Of A Host Parameter
7.Sh SYNOPSIS
8.Ft const char *
9.Fo sqlite3_bind_parameter_name
10.Fa "sqlite3_stmt*"
11.Fa "int"
12.Fc
13.Sh DESCRIPTION
14The sqlite3_bind_parameter_name(P,N) interface returns the name of
15the N-th SQL parameter in the prepared statement
16P.
17SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" have
18a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" respectively.
19In other words, the initial ":" or "$" or "@" or "?" is included as
20part of the name.
21Parameters of the form "?" without a following integer have no name
22and are referred to as "nameless" or "anonymous parameters".
23.Pp
24The first host parameter has an index of 1, not 0.
25.Pp
26If the value N is out of range or if the N-th parameter is nameless,
27then NULL is returned.
28The returned string is always in UTF-8 encoding even if the named parameter
29was originally specified as UTF-16 in sqlite3_prepare16(),
30sqlite3_prepare16_v2(), or sqlite3_prepare16_v3().
31.Pp
32.Sh SEE ALSO
33.Xr sqlite3_stmt 3 ,
34.Xr sqlite3_bind_blob 3 ,
35.Xr sqlite3_bind_parameter_count 3 ,
36.Xr sqlite3_bind_parameter_index 3 ,
37.Xr sqlite3_prepare 3
38