summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_store_result.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_store_result.3')
-rw-r--r--libmariadb/man/mysql_store_result.339
1 files changed, 39 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_store_result.3 b/libmariadb/man/mysql_store_result.3
new file mode 100644
index 00000000..5669063a
--- /dev/null
+++ b/libmariadb/man/mysql_store_result.3
@@ -0,0 +1,39 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_store_result" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_store_result \- returns a buffered result set
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+MYSQL_RES * mysql_store_result(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Returns a buffered resultset from the last executed query.
+### Notes
+.IP \[bu] 2
+mysql_field_count() (imysql_field_count) indicates if there will be a
+result set available.
+.IP \[bu] 2
+The memory allocated by mysql_store_result() needs to be released by
+calling the function \f[B]mysql_free_result(3)\f[R].
+.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 Return value
+.PP
+Returns a buffered result set or NULL in case an error occured or if the
+query didn\[cq]t return data (e.g.\ when executing an INSERT, UPDATE,
+DELETE or REPLACE statement).
+## See also * \f[B]mysql_free_result(3)\f[R] *
+\f[B]mysql_use_result(3)\f[R] * \f[B]mysql_real_query(3)\f[R] *
+\f[B]mysql_field_count(3)\f[R]