summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_fetch_fields.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_fetch_fields.3')
-rw-r--r--libmariadb/man/mysql_fetch_fields.341
1 files changed, 41 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_fetch_fields.3 b/libmariadb/man/mysql_fetch_fields.3
new file mode 100644
index 00000000..cb9c2a22
--- /dev/null
+++ b/libmariadb/man/mysql_fetch_fields.3
@@ -0,0 +1,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]