summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_use_result.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 18:00:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 18:00:34 +0000
commit3f619478f796eddbba6e39502fe941b285dd97b1 (patch)
treee2c7b5777f728320e5b5542b6213fd3591ba51e2 /libmariadb/man/mysql_use_result.3
parentInitial commit. (diff)
downloadmariadb-3f619478f796eddbba6e39502fe941b285dd97b1.tar.xz
mariadb-3f619478f796eddbba6e39502fe941b285dd97b1.zip
Adding upstream version 1:10.11.6.upstream/1%10.11.6upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libmariadb/man/mysql_use_result.3')
-rw-r--r--libmariadb/man/mysql_use_result.346
1 files changed, 46 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_use_result.3 b/libmariadb/man/mysql_use_result.3
new file mode 100644
index 00000000..a0777c29
--- /dev/null
+++ b/libmariadb/man/mysql_use_result.3
@@ -0,0 +1,46 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_use_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_use_result \- returns an unbuffered result set
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <nysql.h>
+
+MYSQL_RES * mysql_use_result(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Used to initiate the retrieval of a result set from the last query
+executed using the mysql_real_query() function on the database
+connection.
+Either this or the \f[B]mysql_store_result(3)\f[R] function must be
+called before the results of a query can be retrieved, and one or the
+other must be called to prevent the next query on that database
+connection from failing.
+.SS Parameters
+.IP \[bu] 2
+\f[C]mysql\f[R] is a connection identifier, which was previously
+allocated by \f[B]mysql_init(3)\f[R] and connected by
+\f[B]mysql_real_connect(3)\f[R].
+.SS Notes
+.PP
+The mysql_use_result() function does not transfer the entire result set.
+Hence several functions like \f[B]mysql_num_rows(3)\f[R] or
+\f[B]mysql_data_seek(3)\f[R] cannot be used.
+mysql_use_result() will block the current connection until all result
+sets are retrieved or result set was released by
+\f[B]mysql_free_result(3)\f[R].
+.SS Return value
+.PP
+Returns an unbuffered result set or \f[C]NULL\f[R] if an error occurred.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_store_result(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_free_result(3)\f[R]