mariadb_cancel

mariadb_cancel immediately aborts a connection by making all subsequent read/write operations fail, without freeing the MYSQL structure or closing communication channels.

Syntax

int mariadb_cancel(MYSQL * mysql);

Parameter

• mysql - mysql handle, which was previously allocated by mysql_init() or mysql_real_connect().

Description

Immediately aborts a connection by making all subsequent read/write operations fail.mariadb_cancel() does not invalidate memory used for mysql structure, nor close any communication channels. To free the memory, mysql_close() must be called.mariadb_cancel() is useful to break long queries in situations where sending KILL is not possible.

Return Value

Returns zero on success or a non-zero value on error.

History

mariadb_cancel() was added in Connector/C 3.0