php-doc-en/reference/mysqli/functions/mysqli-kill.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
  <refentry id="function.mysqli-kill">
   <refnamediv>
    <refname>mysqli_kill</refname>
    <refname>mysqli->kill</refname>
    <refpurpose>Asks the server to kill a MySQL thread</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <para>Procedural style:</para>
     <methodsynopsis>
      <type>bool</type><methodname>mysqli_kill</methodname>
      <methodparam><type>object</type><parameter>link</parameter></methodparam>
      <methodparam><type>int</type><parameter>processid</parameter></methodparam>
     </methodsynopsis>
     <para>Object oriented style (method)</para>
     <classsynopsis>
      <ooclass><classname>mysqli</classname></ooclass>
      <methodsynopsis>
       <type>bool</type>
       <methodname>kill</methodname>
       <methodparam><type>int</type><parameter>processid</parameter></methodparam>
      </methodsynopsis>
     </classsynopsis>
     <para>
     This function is used to ask the server to kill a MySQL thread specified
     by the <parameter>processid</parameter> parameter. This value must be
     retrieved by calling the <function>mysqli_thread_id</function> function.
    </para>
    <note>
     <para>
      To stop a running query you should use the SQL command
      <literal>KILL QUERY processid</literal>.
     </para>
    </note>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>&return.success;</para>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>mysqli_thread_id</function>
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->