summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_stmt_row_tell.3
blob: ef754c209022c0720bdc85aa649d0781c4a9af75 (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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_stmt_row_tell" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_stmt_row_tell \- Returns position of row cursor
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

MYSQL_ROW_OFFSET mysql_stmt_row_tell(MYSQL_STMT * stmt);
\f[R]
.fi
.SS Description
.PP
Returns the row offset of a result cursor.
The returned offset value can be used to reposition the result cursor by
calling \f[B]mysql_stmt_row_seek(3)\f[R].
.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].
.SS Return value
.PP
Returns the current position of the row cursor.
.SS Notes
.IP \[bu] 2
This function can be used for buffered result sets only, which can be
obtained by executing the \f[B]mysql_stmt_store_result(3)\f[R] function.
.SS See Also
.IP \[bu] 2
\f[B]mysql_stmt_row_seek(3)\f[R]
.IP \[bu] 2
\f[B]mysql_stmt_store_result(3)\f[R]