summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_use_result.3
blob: a0777c292de04199897f532e1479a569bada256e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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]