SQLITE3_BIND_PARAMETER_NAME(3)

SQLITE3_BIND_PARAMETER_NAME(3) | Library Functions Manual | SQLITE3_BIND_PARAMETER_NAME(3)

# NAME

`sqlite3_bind_parameter_name` — name of a host parameter

# SYNOPSIS

`#include <sqlite3.h>`

const char *
`sqlite3_bind_parameter_name`(sqlite3_stmt*, int);

# 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".

The first host parameter has an index of 1, not 0.

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 `sqlite3_prepare16`(), `sqlite3_prepare16_v2`(), or `sqlite3_prepare16_v3`().

# IMPLEMENTATION NOTES

These declarations were extracted from the interface documentation at line 4720.

    SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);

# SEE ALSO

sqlite3_bind_blob(3), sqlite3_bind_parameter_count(3), sqlite3_bind_parameter_index(3), sqlite3_prepare(3), sqlite3_stmt(3)

January 24, 2024 | NetBSD 11.0