1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-04-18 21:24:07 +03:00
mariadb-connector-c/man/mysql_fetch_fields.3
2024-10-25 07:38:00 +02:00

35 lines
1018 B
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_fetch_fields" "3" "" "Version 3.3" "MariaDB Connector/C"
.SS Name
mysql_fetch_fields \- returns an array of fields
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
MYSQL_FIELD * mysql_fetch_fields(MYSQL_RES * res);
.EE
.SS Description
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[CR]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
The total number of fields can be obtained by
\f[B]mysql_field_count(3)\f[R].
.SS Return value
an array of type \f[CR]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]