1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-08-08 14:02:17 +03:00
Files
mariadb-connector-c/man/mysql_stmt_close.3
Georg Richter 10c67ee835 Man page fixes:
- Install created man pages when building with WITH_DOCS=ON
- Set version to 3.4
2024-10-25 10:37:47 +02:00

34 lines
980 B
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_stmt_close" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mysql_stmt_close \- Closes a prepared statement
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
my_bool mysql_stmt_close(MYSQL_STMT * stmt);
.EE
.SS Description
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[CR]stmt\f[R] \- a statement handle, which was previously allocated by
\f[B]mysql_stmt_init(3)\f[R].
.SS Return value
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]