summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_connection.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mariadb_connection.3')
-rw-r--r--libmariadb/man/mariadb_connection.329
1 files changed, 29 insertions, 0 deletions
diff --git a/libmariadb/man/mariadb_connection.3 b/libmariadb/man/mariadb_connection.3
new file mode 100644
index 00000000..a2b571b5
--- /dev/null
+++ b/libmariadb/man/mariadb_connection.3
@@ -0,0 +1,29 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mariadb_connection" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mariadb_connection \- checks if the client is connected to a MariaDB
+database server
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+my_bool mariadb_connection(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Checks if the client is connected to a MariaDB or MySQL database server.
+.SS Parameter
+.PP
+\f[C]mysql\f[R] \- mysql handle, which was previously allocated by
+\f[B]mysql_init(3)\f[R] and connected by
+\f[B]mysql_real_connect(3)\f[R].
+.SS Return value
+.PP
+Returns a non zero value if connected to a MariaDB database server,
+otherwise zero.