summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_field_seek.3
blob: 364909aac401ef7fff3072ae678b8bf2376db902 (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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_field_seek" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_field_seek \- sets the field cursor to given offset
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

MYSQL_FIELD_OFFSET mysql_field_seek(MYSQL_RES * result,
                                    MYSQL_FIELD_OFFSET offset);
\f[R]
.fi
.SS Description
.PP
Sets the field cursor to the given offset.
The next call to \f[B]mysql_fetch_field(3)\f[R] will retrieve the field
definition of the column associated with that offset.
.SS Parameters
.IP \[bu] 2
\f[C]result\f[R] \- a result set identifier returned by
\f[B]mysql_store_result(3)\f[R] or \f[B]mysql_use_result(3)\f[R].
.IP \[bu] 2
\f[C]offset\f[R] \- the field number.
This number must be in the range from
\f[C]0\f[R]..\f[C]number of fields \- 1\f[R].
.SS Notes
.IP \[bu] 2
The number of fields can be obtained from \f[B]mysql_field_count(3)\f[R]
\&.
.IP \[bu] 2
To move the field cursor to the first field offset parameter should be
zero.
.SS Return value
.PP
Returns the previous value of the field cursor
.SS See also
.IP \[bu] 2
\f[B]mysql_field_tell(3)\f[R]