VladPolskiy/mariadb-connector-c
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-08-16 17:15:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated man pages (rebuilt with pandoc 3.5)

Browse Source
This commit is contained in:
Georg Richter
2024-10-24 20:50:13 +02:00
parent e8234ba791
commit e06ff35fd7
128 changed files with 1637 additions and 2257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
man/mysql_stmt_attr_get.3
View File

@ -1,39 +1,33 @@
.\"t
.\" Automatically generated by Pandoc 2.5
'\" t
.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_stmt_attr_get" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.TH "mysql_stmt_attr_get" "3" "" "Version 3.4.2" "MariaDB Connector/C"
.SS Name
.PP
mysql_stmt_attr_get \- Gets the current value of a statement attribute
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
.EX
#include \f[B]<mysql.h>\f[R]
my_bool mysql_stmt_attr_get(MYSQL_STMT * stmt,
enum enum_stmt_attr_type,
\f[B]enum\f[R] enum_stmt_attr_type,
void * attr);
\f[R]
.fi
.EE
.SS Description
.PP
Gets the current value of a statement attribute.
Returns zero on success, non zero on failure.
.SS Parameter
.IP \[bu] 2
\f[C]stmt\f[R] \- a statement handle, which was previously allocated by
\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[C]enum_stmt_attr_type\f[R] \- attribute.
\f[CR]enum_stmt_attr_type\f[R] \- attribute.
See below.
.IP \[bu] 2
\f[C]attr\f[R] \- pointer to a variable, which will contain the
\f[CR]attr\f[R] \- pointer to a variable, which will contain the
attribute value.
.SS Attribute types
.PP
The \f[C]enum_stmt_attr_type\f[R] parameter has the following possible
The \f[CR]enum_stmt_attr_type\f[R] parameter has the following possible
values:
.PP
.TS
@ -48,43 +42,43 @@ Description
T}
_
T{
\f[C]STMT_ATTR_UPDATE_MAX_LENGTH\f[R]
\f[CR]STMT_ATTR_UPDATE_MAX_LENGTH\f[R]
T}@T{
\f[C]my_bool *\f[R]
\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[C]MYSQL_FIELD\f[R] structures.
max_length value of \f[CR]MYSQL_FIELD\f[R] structures.
T}
T{
\f[C]STMT_ATTR_CURSOR_TYPE\f[R]
\f[CR]STMT_ATTR_CURSOR_TYPE\f[R]
T}@T{
\f[C]unsigned long *\f[R]
\f[CR]unsigned long *\f[R]
T}@T{
Possible values are \f[C]CURSOR_TYPE_READ_ONLY\f[R] or default value
\f[C]CURSOR_TYPE_NO_CURSOR\f[R].
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[C]STMT_ATTR_PREFETCH_ROWS\f[R]
\f[CR]STMT_ATTR_PREFETCH_ROWS\f[R]
T}@T{
\f[C]unsigned long *\f[R]
\f[CR]unsigned long *\f[R]
T}@T{
Number of rows which will be prefetched.
The default value is 1.
T}
T{
\f[C]STMT_ATTR_PREBIND_PARAMS\f[R]
\f[CR]STMT_ATTR_PREBIND_PARAMS\f[R]
T}@T{
\f[C]unsigned int *\f[R]
\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[C]STMT_ATTR_STATE\f[R]
\f[CR]STMT_ATTR_STATE\f[R]
T}@T{
\f[C]enum mysql_stmt_state *\f[R]
\f[CR]enum mysql_stmt_state *\f[R]
T}@T{
Status of prepared statement.
Possible values are defined in \f[C]enum mysql_stmt_state\f[R].
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