summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_init.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_init.3')
-rw-r--r--libmariadb/man/mysql_init.339
1 files changed, 39 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_init.3 b/libmariadb/man/mysql_init.3
new file mode 100644
index 00000000..5f2c3f40
--- /dev/null
+++ b/libmariadb/man/mysql_init.3
@@ -0,0 +1,39 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_init" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_init \- Prepares and initializes a \f[C]MYSQL\f[R] structure
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+MYSQL *mysql_init(MYSQL *mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Prepares and initializes a \f[C]MYSQL\f[R] structure to be used with
+\f[B]mysql_real_connect(3)\f[R].
+If an address of a \f[C]MYSQL\f[R] structure was passed as parameter,
+the structure will be initialized, if \f[C]NULL\f[R] was passed, a new
+structure will be allocated and initialized.
+.PP
+\f[B]Notes:\f[R] * If parameter \f[C]mysql\f[R] is not \f[C]NULL\f[R]
+\f[B]mysql_close(3)\f[R] API function will not release the memory * Any
+subsequent calls to any function (except \f[B]mysql_optionsv(3)\f[R]
+will fail until \f[B]mysql_real_connect(3)\f[R] was called.
+* Memory allocated by \f[C]mysql_init()\f[R] must be freed with
+\f[B]mysql_close(3)\f[R].
+.SS Return value
+.PP
+The \f[C]mysql_init()\f[R] function returns an address of a
+\f[C]MYSQL\f[R] structure, or NULL in case of memory allcation error.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_close(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_optionsv(3)\f[R]