summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_field_count.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_field_count.3')
-rw-r--r--libmariadb/man/mysql_field_count.343
1 files changed, 43 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_field_count.3 b/libmariadb/man/mysql_field_count.3
new file mode 100644
index 00000000..ad3144c6
--- /dev/null
+++ b/libmariadb/man/mysql_field_count.3
@@ -0,0 +1,43 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_field_count" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_field_count \- returns the number of columns for the most recent
+statement
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+unsigned int mysql_field_count(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Returns the number of columns for the most recent statement on the
+connection represented by the link parameter as an unsigned integer.
+This function can be useful when using the
+\f[B]mysql_store_result(3)\f[R] function to determine if the query
+should have produced a non\-empty result set or not without knowing the
+nature of the query.
+.SS Parameters
+.IP \[bu] 2
+\f[C]mysql\f[R] is a connection identifier, which was previously
+allocated by \f[B]mysql_init(3)\f[R] and connected by
+\f[B]mysql_real_connect(3)\f[R].
+.SS Notes
+.PP
+The \f[C]mysql_field_count()\f[R] function should be used to determine
+if there is a result set available.
+.SS Return value:
+.PP
+The number of columns for the most recent statemet.
+The value is zero, if the statemet didn\[cq]t produce a result set.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_store_result(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_use_result(3)\f[R]