mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-07-23 05:19:42 +00:00
92 lines
2.0 KiB
Groff
92 lines
2.0 KiB
Groff
'\" t
|
|
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mysql_stmt_attr_get" "3" "" "Version 3.4" "MariaDB Connector/C"
|
|
.SS Name
|
|
mysql_stmt_attr_get \- Gets the current value of a statement attribute
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mysql.h>\f[R]
|
|
|
|
my_bool mysql_stmt_attr_get(MYSQL_STMT * stmt,
|
|
\f[B]enum\f[R] enum_stmt_attr_type,
|
|
void * attr);
|
|
.EE
|
|
.SS Description
|
|
Gets the current value of a statement attribute.
|
|
Returns zero on success, non zero on failure.
|
|
.SS Parameter
|
|
.IP \[bu] 2
|
|
\f[CR]stmt\f[R] \- a statement handle, which was previously allocated by
|
|
\f[B]mysql_stmt_init(3)\f[R].
|
|
.IP \[bu] 2
|
|
\f[CR]enum_stmt_attr_type\f[R] \- attribute.
|
|
See below.
|
|
.IP \[bu] 2
|
|
\f[CR]attr\f[R] \- pointer to a variable, which will contain the
|
|
attribute value.
|
|
.SS Attribute types
|
|
The \f[CR]enum_stmt_attr_type\f[R] parameter has the following possible
|
|
values:
|
|
.PP
|
|
.TS
|
|
tab(@);
|
|
lw(23.3n) lw(23.3n) lw(23.3n).
|
|
T{
|
|
Value
|
|
T}@T{
|
|
Type
|
|
T}@T{
|
|
Description
|
|
T}
|
|
_
|
|
T{
|
|
\f[CR]STMT_ATTR_UPDATE_MAX_LENGTH\f[R]
|
|
T}@T{
|
|
\f[CR]my_bool *\f[R]
|
|
T}@T{
|
|
Indicates if \f[B]mysql_stmt_store_result(3)\f[R] will update the
|
|
max_length value of \f[CR]MYSQL_FIELD\f[R] structures.
|
|
T}
|
|
T{
|
|
\f[CR]STMT_ATTR_CURSOR_TYPE\f[R]
|
|
T}@T{
|
|
\f[CR]unsigned long *\f[R]
|
|
T}@T{
|
|
Possible values are \f[CR]CURSOR_TYPE_READ_ONLY\f[R] or default value
|
|
\f[CR]CURSOR_TYPE_NO_CURSOR\f[R].
|
|
T}
|
|
T{
|
|
\f[CR]STMT_ATTR_PREFETCH_ROWS\f[R]
|
|
T}@T{
|
|
\f[CR]unsigned long *\f[R]
|
|
T}@T{
|
|
Number of rows which will be prefetched.
|
|
The default value is 1.
|
|
T}
|
|
T{
|
|
\f[CR]STMT_ATTR_PREBIND_PARAMS\f[R]
|
|
T}@T{
|
|
\f[CR]unsigned int *\f[R]
|
|
T}@T{
|
|
Number of parameters used for \f[B]mariadb_stmt_execute_direct(3)\f[R]
|
|
T}
|
|
T{
|
|
\f[CR]STMT_ATTR_STATE\f[R]
|
|
T}@T{
|
|
\f[CR]enum mysql_stmt_state *\f[R]
|
|
T}@T{
|
|
Status of prepared statement.
|
|
Possible values are defined in \f[CR]enum mysql_stmt_state\f[R].
|
|
This option was added in MariaDB Connector/C 3.1.0
|
|
T}
|
|
.TE
|
|
.SS Notes
|
|
.IP \[bu] 2
|
|
Setting the number of prefetched rows will work only for read only
|
|
cursors.
|
|
.SS See Also
|
|
.IP \[bu] 2
|
|
\f[B]mysql_stmt_attr_set(3)\f[R]
|