File: mariadb_cancel.3

package info (click to toggle)
mariadb 1%3A10.11.14-0%2Bdeb12u2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 614,128 kB
  • sloc: ansic: 2,421,226; cpp: 1,765,048; asm: 381,336; perl: 62,256; java: 39,363; pascal: 38,841; sh: 38,242; sql: 19,830; yacc: 19,731; xml: 10,414; python: 10,125; ruby: 8,544; cs: 6,542; makefile: 6,155; ada: 1,879; lex: 1,207; javascript: 996; objc: 80; tcl: 73; awk: 46; php: 22
file content (28 lines) | stat: -rw-r--r-- 958 bytes parent folder | download 
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
 
.\" 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