mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 00:37:15 +01:00
40 lines
999 B
Groff
40 lines
999 B
Groff
.\" Automatically generated by Pandoc 2.5
|
|
.\"
|
|
.TH "mysql_stmt_close" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
|
.hy
|
|
.SS Name
|
|
.PP
|
|
mysql_stmt_close \- Closes a prepared statement
|
|
.SS Synopsis
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
#include <mysql.h>
|
|
|
|
my_bool mysql_stmt_close(MYSQL_STMT * stmt);
|
|
\f[R]
|
|
.fi
|
|
.SS Description
|
|
.PP
|
|
Closes a prepared statement and deallocates the statement handle.
|
|
If the current statement has pending or unread results, this function
|
|
cancels them so that the next query can be executed.
|
|
.SS Parameter
|
|
.IP \[bu] 2
|
|
\f[C]stmt\f[R] \- a statement handle, which was previously allocated by
|
|
\f[B]mysql_stmt_init(3)\f[R].
|
|
.SS Return value
|
|
.PP
|
|
Returns zero on success, nonzero on error (when communicating with the
|
|
server).
|
|
The statement is deallocated, regardless of the error.
|
|
.SS Notes
|
|
.IP \[bu] 2
|
|
If you want to reuse the statement handle with a different SQL command,
|
|
use \f[B]mysql_stmt_reset(3)\f[R].
|
|
.SS See Also
|
|
.IP \[bu] 2
|
|
\f[B]mysql_stmt_init(3)\f[R]
|
|
.IP \[bu] 2
|
|
\f[B]mysql_stmt_reset(3)\f[R]
|