5.4.39 mysql_kill()

int
mysql_kill(MYSQL *mysql,
           unsigned long pid)

Description

Note

As of MySQL 5.7.11, mysql_kill() is deprecated and is subject to removal in a future version of MySQL. Instead, use mysql_real_query() or mysql_query() to execute a KILL statement.

Asks the server to kill the thread specified by pid.

mysql_kill() cannot handle values larger than 32 bits, but to guard against killing the wrong thread returns an error in these cases:

• If given an ID larger than 32 bits, mysql_kill() returns a CR_INVALID_CONN_HANDLE error.

• After the server's internal thread ID counter reaches a value larger than 32 bits, it returns an ER_DATA_OUT_OF_RANGE error for any mysql_kill() invocation and mysql_kill() fails.

Return Values

Zero for success. Nonzero if an error occurred.

Errors

• CR_COMMANDS_OUT_OF_SYNC

  Commands were executed in an improper order.

• CR_INVALID_CONN_HANDLE

  The pid was larger than 32 bits.

• CR_SERVER_GONE_ERROR

  The MySQL server has gone away.

• CR_SERVER_LOST

  The connection to the server was lost during the query.

• CR_UNKNOWN_ERROR

  An unknown error occurred.

• ER_DATA_OUT_OF_RANGE

  The server's internal thread ID counter has reached a value larger than 32 bits, at which point it rejects all mysql_kill() invocations.