summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_stmt_fetch_column.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_stmt_fetch_column.3')
-rw-r--r--libmariadb/man/mysql_stmt_fetch_column.344
1 files changed, 44 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_stmt_fetch_column.3 b/libmariadb/man/mysql_stmt_fetch_column.3
new file mode 100644
index 00000000..d0c559a8
--- /dev/null
+++ b/libmariadb/man/mysql_stmt_fetch_column.3
@@ -0,0 +1,44 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_stmt_fetch_column" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_stmt_fetch_column \- Fetches a single column into bind buffer
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+int mysql_stmt_fetch_column(MYSQL_STMT * stmt,
+ MYSQL_BIND * bind_arg,
+ unsigned int column,
+ unsigned long offset);
+\f[R]
+.fi
+.SS Description
+.PP
+This function can be used to fetch large data of a single column in
+pieces.
+.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].
+.IP \[bu] 2
+\f[C]bind_arg\f[R] \- a pointer to a MYSQL_BIND structure.
+.IP \[bu] 2
+\f[C]column\f[R] \- number of column, first column is numbered zero.
+.IP \[bu] 2
+\f[C]offset\f[R] \- offset at which to begin retrieving data.
+.SS Return value
+.PP
+Returns zero on success, non\-zero on failure.
+.SS Notes
+.IP \[bu] 2
+The size of the buffer is specified within MYSQL_BIND structure.
+.SS See Also
+.IP \[bu] 2
+\f[B]mysql_stmt_fetch(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_stmt_send_long_data(3)\f[R]