summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_fetch_fields.3
blob: cb9c2a22a3cd175c1494b9545bf669844c825c4d (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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_fetch_fields" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_fetch_fields \- returns an array of fields
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

MYSQL_FIELD * mysql_fetch_fields(MYSQL_RES * res);
\f[R]
.fi
.SS Description
.PP
This function serves an identical purpose to the
\f[B]mysql_fetch_field(3)\f[R] function with the single difference that
instead of returning one field at a time for each field, the fields are
returned as an array.
Each field contains the definition for a column of the result set.
.SS Parameters
.IP \[bu] 2
\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].
.SS Notes
.PP
The total number of fields can be obtained by
\f[B]mysql_field_count(3)\f[R].
.SS Return value
.PP
an array of type \f[C]MYSQL_FIELD\f[R].
.SS See also
.IP \[bu] 2
\f[B]mysql_fetch_field(3)\f[R]
.IP \[bu] 2
\f[B]mysql_fetch_field_direct(3)\f[R]
.IP \[bu] 2
\f[B]mysql_field_count(3)\f[R]