1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-08-08 14:02:17 +03:00
Files
mariadb-connector-c/man/mysql_stmt_fetch.3
2024-10-25 07:38:00 +02:00

43 lines
1.3 KiB
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_stmt_fetch" "3" "" "Version 3.3" "MariaDB Connector/C"
.SS Name
mysql_stmt_fetch \- Fetches result set row from a prepared statement
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
int mysql_stmt_fetch(MYSQL_STMT * stmt);
.EE
.SS Description
Fetch the result from a prepared statement into the buffer bound by
[mysql_stmt_bind_result()}(mysql_stmt_bind_result).
.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].
.SS Return value
Returns \f[CR]0\f[R] for success, \f[CR]MYSQL_NO_DATA\f[R] if the end of
the result set has been reached, or \f[CR]MYSQL_DATA_TRUNCATION\f[R] if
one or more values are truncated.
.SS Notes
.IP \[bu] 2
Note that all columns must be bound by the application before calling
mysql_stmt_fetch().
.IP \[bu] 2
Data are transferred unbuffered without calling
\f[B]mysql_stmt_store_result(3)\f[R] which can decrease performance (but
reduces memory cost).
.IP \[bu] 2
Truncation reporting must be enabled by function
\f[B]mysql_optionsv(3)\f[R] with option
\f[CR]MYSQL_REPORT_DATA_TRUNCATION\f[R]
.SS See Also
.IP \[bu] 2
\f[B]mysql_stmt_prepare(3)\f[R]
.IP \[bu] 2
\f[B]mysql_stmt_bind_result(3)\f[R]
.IP \[bu] 2
\f[B]mysql_stmt_execute(3)\f[R]