blob: daab06b49f2e882357357d5e4961bfc42ad28445 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
.Dd January 24, 2024
.Dt SQLITE3_BIND_PARAMETER_NAME 3
.Os
.Sh NAME
.Nm sqlite3_bind_parameter_name
.Nd name of a host parameter
.Sh SYNOPSIS
.In sqlite3.h
.Ft const char *
.Fo sqlite3_bind_parameter_name
.Fa "sqlite3_stmt*"
.Fa "int"
.Fc
.Sh DESCRIPTION
The sqlite3_bind_parameter_name(P,N) interface returns the name of
the N-th SQL parameter in the prepared statement
P.
SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA" have
a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA" respectively.
In other words, the initial ":" or "$" or "@" or "?" is included as
part of the name.
Parameters of the form "?" without a following integer have no name
and are referred to as "nameless" or "anonymous parameters".
.Pp
The first host parameter has an index of 1, not 0.
.Pp
If the value N is out of range or if the N-th parameter is nameless,
then NULL is returned.
The returned string is always in UTF-8 encoding even if the named parameter
was originally specified as UTF-16 in
.Fn sqlite3_prepare16 ,
.Fn sqlite3_prepare16_v2 ,
or
.Fn sqlite3_prepare16_v3 .
.Sh IMPLEMENTATION NOTES
These declarations were extracted from the
interface documentation at line 4720.
.Bd -literal
SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
.Ed
.Sh SEE ALSO
.Xr sqlite3_bind_blob 3 ,
.Xr sqlite3_bind_parameter_count 3 ,
.Xr sqlite3_bind_parameter_index 3 ,
.Xr sqlite3_prepare 3 ,
.Xr sqlite3_stmt 3
|
