mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 16:57:16 +01:00
37 lines
981 B
Groff
37 lines
981 B
Groff
|
.\" Automatically generated by Pandoc 2.5
|
||
|
|
.\"
|
||
|
|
.TH "mariadb_cancel" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||
|
|
.hy
|
||
|
|
.SS Name
|
||
|
|
.PP
|
||
|
|
mariadb_cancel \- Immediately aborts a connection
|
||
|
|
.SS Synopsis
|
||
|
|
.IP
|
||
|
|
.nf
|
||
|
|
\f[C]
|
||
|
|
#include <mysql.h>
|
||
|
|
|
||
|
|
int mariadb_cancel(MYSQL * mysql);
|
||
|
|
\f[R]
|
||
|
|
.fi
|
||
|
|
.SS Description
|
||
|
|
.PP
|
||
|
|
Immediately aborts a connection by making all subsequent read/write
|
||
|
|
operations fail.
|
||
|
|
\f[C]mariadb_cancel()\f[R] does not invalidate memory used for
|
||
|
|
\f[C]mysql\f[R] structure, nor close any communication channels.
|
||
|
|
To free the memory, \f[B]mysql_close(3)\f[R] must be called.
|
||
|
|
\f[C]mariadb_cancel()\f[R] is useful to break long queries in situations
|
||
|
|
where sending KILL is not possible.
|
||
|
|
.SS Parameter
|
||
|
|
.PP
|
||
|
|
\f[C]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
|
||
|
|
.PP
|
||
|
|
Returns zero on success or a non\-zero value on error.
|
||
|
|
.SS History
|
||
|
|
.PP
|
||
|
|
\f[C]mariadb_cancel()\f[R] was added in Connector/C 3.0
|