File: mysql_field_seek.3

package info (click to toggle)
mariadb 1%3A11.8.3-0%2Bdeb13u1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 772,508 kB
  • sloc: ansic: 2,414,714; cpp: 1,791,394; asm: 381,336; perl: 62,905; sh: 49,647; pascal: 40,897; java: 39,363; python: 20,791; yacc: 20,432; sql: 17,907; xml: 12,344; ruby: 8,544; cs: 6,542; makefile: 6,145; ada: 1,879; lex: 1,193; javascript: 996; objc: 80; tcl: 73; awk: 46; php: 22
file content (37 lines) | stat: -rw-r--r-- 1,133 bytes parent folder | download | duplicates (2) 
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 3.5
.\"
.TH "mysql_field_seek" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mysql_field_seek \- sets the field cursor to given offset
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]

MYSQL_FIELD_OFFSET mysql_field_seek(MYSQL_RES * result,
                                    MYSQL_FIELD_OFFSET offset);
.EE
.SS Description
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[CR]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[CR]offset\f[R] \- the field number.
This number must be in the range from
\f[CR]0\f[R]..\f[CR]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
Returns the previous value of the field cursor
.SS See also
.IP \[bu] 2
\f[B]mysql_field_tell(3)\f[R]