diff options
Diffstat (limited to 'libmariadb/man/mysql_stmt_close.3')
-rw-r--r-- | libmariadb/man/mysql_stmt_close.3 | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_stmt_close.3 b/libmariadb/man/mysql_stmt_close.3 new file mode 100644 index 00000000..a7499ee8 --- /dev/null +++ b/libmariadb/man/mysql_stmt_close.3 @@ -0,0 +1,39 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_stmt_close" "3" "" "Version 3.3.1" "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] |