You've already forked mariadb-connector-c
mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-08-08 14:02:17 +03:00
29 lines
958 B
Groff
29 lines
958 B
Groff
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mariadb_cancel" "3" "" "Version 3.3" "MariaDB Connector/C"
|
|
.SS Name
|
|
mariadb_cancel \- Immediately aborts a connection
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mysql.h>\f[R]
|
|
|
|
int mariadb_cancel(MYSQL * mysql);
|
|
.EE
|
|
.SS Description
|
|
Immediately aborts a connection by making all subsequent read/write
|
|
operations fail.
|
|
\f[CR]mariadb_cancel()\f[R] does not invalidate memory used for
|
|
\f[CR]mysql\f[R] structure, nor close any communication channels.
|
|
To free the memory, \f[B]mysql_close(3)\f[R] must be called.
|
|
\f[CR]mariadb_cancel()\f[R] is useful to break long queries in
|
|
situations where sending KILL is not possible.
|
|
.SS Parameter
|
|
\f[CR]mysql\f[R] \- 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
|
|
Returns zero on success or a non\-zero value on error.
|
|
.SS History
|
|
\f[CR]mariadb_cancel()\f[R] was added in Connector/C 3.0
|