summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_fetch_field.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_fetch_field.3')
-rw-r--r--libmariadb/man/mysql_fetch_field.349
1 files changed, 49 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_fetch_field.3 b/libmariadb/man/mysql_fetch_field.3
new file mode 100644
index 00000000..bb3e7e3c
--- /dev/null
+++ b/libmariadb/man/mysql_fetch_field.3
@@ -0,0 +1,49 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_fetch_field" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_fetch_field \- Returns the definition of one column of a result
+set
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+MYSQL_FIELD * mysql_fetch_field(MYSQL_RES * result);
+\f[R]
+.fi
+.SS Description
+.PP
+Returns the definition of one column of a result set as a pointer to a
+MYSQL_FIELD structure.
+Call this function repeatedly to retrieve information about all columns
+in the result set.
+.SS Parameters
+.IP \[bu] 2
+\f[C]result\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
+.IP \[bu] 2
+The field order will be reset if you execute a new SELECT query.
+.IP \[bu] 2
+In case only information for a specific field is required the field can
+be selected by using the \f[B]mysql_field_seek(3)\f[R] function or
+obtained by \f[B]mysql_fetch_field_direct(3)\f[R] function.
+.SS Return value
+.PP
+a pointer of a \f[C]MYSQL_FIELD\f[R] structure, or NULL if there are no
+more fields.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_field_seek(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_field_tell(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_fetch_field_direct(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_store_result(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_use_result(3)\f[R]