blob: 38729c2d9264ccb106fa1d70da229d7f5c6cad4c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mariadb_cancel" "3" "" "Version 3.3.1" "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
|
