mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
42 lines
1.0 KiB
Groff
42 lines
1.0 KiB
Groff
|
.\" Automatically generated by Pandoc 2.5
|
||
|
|
.\"
|
||
|
|
.TH "mysql_fetch_fields" "3" "" "Version 3.2.2" "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]
|