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

MYSQL_ROW_OFFSET mysql_stmt_row_seek(MYSQL_STMT * stmt,
                                     MYSQL_ROW_OFFSET offset);
\f[R]
.fi
.SS Description
.PP
Positions the row cursor to an arbitrary row in a result set which was
obtained by \f[B]mysql_stmt_store_result(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].
.IP \[bu] 2
\f[C]offset\f[R] \- row offset.
This value can be obtained either by mysql_stmt_row_seek() or
\f[B]mysql_stmt_row_tell(3)\f[R].
.SS Return value
.PP
Returns the previous row offset.
.SS Notes
.PP
The result set must be obtained by \f[B]mysql_use_result(3)\f[R].
.SS See Also
.IP \[bu] 2
\f[B]mysql_stmt_row_tell(3)\f[R]
.IP \[bu] 2
\f[B]mysql_stmt_store_result(3)\f[R]