summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_fetch_field_direct.3
blob: cc5d03edd1280422c63d0da95b266798e3563a08 (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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_fetch_field_direct" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_fetch_field_direct \- Returns a pointer to a MYSQL_FIELD structure
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

MYSQL_FIELD * mysql_fetch_field_direct(MYSQL_RES * res,
                                       unsigned int fieldnr);
\f[R]
.fi
.SS Description
.PP
Returns a pointer to a \f[C]MYSQL_FIELD\f[R] structure which contains
field information from the specified result set.
### Parameter * \f[C]res\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].
* \f[C]fieldnr\f[R] \- the field number.
This value must be within the range from 0 to number of fields \- 1 ###
Notes * The total number of fields can be obtained by
mysql_field_count()
.SS Return value
.PP
Pointer to a \f[C]MYSQL_FIELD\f[R] structure or \f[C]NULL\f[R] if an
invalid field number was specified
.SS See also
.IP \[bu] 2
\f[B]mysql_fetch_field(3)\f[R]
.IP \[bu] 2
\f[B]mysql_field_count(3)\f[R]