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