mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
44 lines
1.1 KiB
Groff
44 lines
1.1 KiB
Groff
.\" Automatically generated by Pandoc 2.5
|
|
.\"
|
|
.TH "mysql_stmt_init" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
|
.hy
|
|
.SS Name
|
|
.PP
|
|
mysql_stmt_init \- Initializes a prepared statement handle
|
|
.SS Synopsis
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
#include <mysql.h>
|
|
|
|
MYSQL_STMT * mysql_stmt_init(MYSQL * mysql);
|
|
\f[R]
|
|
.fi
|
|
.SS Description
|
|
.PP
|
|
Initializes and allocates memory for a prepared statement.
|
|
.SS Parameter
|
|
.IP \[bu] 2
|
|
\f[C]mysql\f[R] \- a 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 pointer to a \f[C]MYSQL_STMT\f[R] structure or \f[C]NULL\f[R]
|
|
if an error occurred.
|
|
.SS Notes
|
|
.IP \[bu] 2
|
|
Members of the \f[C]MYSQL_STMT\f[R] structure are not intended for
|
|
application use.
|
|
.IP \[bu] 2
|
|
A statement handle which was allocated by mysql_stmt_init() needs to be
|
|
freed with \f[B]mysql_stmt_close(3)\f[R].
|
|
.IP \[bu] 2
|
|
Any subsequent calls to any mysql_stmt function will fail until
|
|
\f[B]mysql_stmt_prepare(3)\f[R] was called.
|
|
.SS See Also
|
|
.IP \[bu] 2
|
|
\f[B]mysql_stmt_close(3)\f[R]
|
|
.IP \[bu] 2
|
|
\f[B]mysql_stmt_prepare(3)\f[R]
|