diff options
Diffstat (limited to 'libmariadb/man/mysql_stmt_fetch.3')
-rw-r--r-- | libmariadb/man/mysql_stmt_fetch.3 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_stmt_fetch.3 b/libmariadb/man/mysql_stmt_fetch.3 new file mode 100644 index 00000000..49ab8576 --- /dev/null +++ b/libmariadb/man/mysql_stmt_fetch.3 @@ -0,0 +1,48 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_stmt_fetch" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mysql_stmt_fetch \- Fetches result set row from a prepared statement +.SS Synopsis +.IP +.nf +\f[C] +#include <mysql.h> + +int mysql_stmt_fetch(MYSQL_STMT * stmt); +\f[R] +.fi +.SS Description +.PP +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[C]stmt\f[R] \- a statement handle, which was previously allocated by +\f[B]mysql_stmt_init(3)\f[R]. +.SS Return value +.PP +Returns \f[C]0\f[R] for success, \f[C]MYSQL_NO_DATA\f[R] if the end of +the result set has been reached, or \f[C]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[C]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] |