summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_read_query_result.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_read_query_result.3')
-rw-r--r--libmariadb/man/mysql_read_query_result.339
1 files changed, 39 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_read_query_result.3 b/libmariadb/man/mysql_read_query_result.3
new file mode 100644
index 00000000..5f066f0f
--- /dev/null
+++ b/libmariadb/man/mysql_read_query_result.3
@@ -0,0 +1,39 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_read_query_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_read_query_result \- waits for a server result or response package
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+my_bool mysql_read_query_result(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Waits for a server result set or response package from a previously
+executed \f[B]mysql_send_query(3)\f[R].
+.SS Parameters
+.IP \[bu] 2
+\f[C]mysql\f[R] \- a mysql handle, which was previously allocated by
+\f[B]mysql_init(3)\f[R] and connected by
+\f[B]mysql_real_connect(3)\f[R].
+.SS Return value
+.PP
+Zero on success, non zero on error.
+.SS Example
+.PP
+For an example how to use \[cq]mysql_send_query()\[ga] in an event
+driven model, please check Jan Kneschke\[cq]s Blog entry \[lq]Async
+MySQL Queries with
+C\-API\[rq] (https://jan.kneschke.de/projects/mysql/async-mysql-queries-with-c-api/).
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_real_query(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_send_query(3)\f[R]