mysql_init.3

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_init" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mysql_init \- Prepares and initializes a \f[CR]MYSQL\f[R] structure
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]

MYSQL *mysql_init(MYSQL *mysql);
.EE
.SS Description
Prepares and initializes a \f[CR]MYSQL\f[R] structure to be used with
\f[B]mysql_real_connect(3)\f[R].
If an address of a \f[CR]MYSQL\f[R] structure was passed as parameter,
the structure will be initialized, if \f[CR]NULL\f[R] was passed, a new
structure will be allocated and initialized.
.PP
\f[B]Notes:\f[R] * If parameter \f[CR]mysql\f[R] is not \f[CR]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[CR]mysql_init()\f[R] must be freed with
\f[B]mysql_close(3)\f[R].
.SS Return value
The \f[CR]mysql_init()\f[R] function returns an address of a
\f[CR]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]