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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
  <refentry id="function.mysqli-debug">
   <refnamediv>
    <refname>mysqli_debug</refname>
    <refpurpose>Performs debugging operations</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>mysqli_debug</methodname>
      <methodparam><type>string</type><parameter>debug</parameter></methodparam>
     </methodsynopsis>
    <para>
     The <function>mysqli_debug</function> function is used to perform debugging
     operations using the Fred Fish debugging library. The <parameter>debug</parameter>
     parameter is a string representing the debugging operation to perform.
    </para>
    <note>
     <para>
      To use the <function>mysqli_debug</function> function you must complile
      the MySQL client library to support debugging.
     </para>
    </note>
   </refsect1>
   <refsect1>
    <title>Return values</title>
    <para><function>mysqli_debug</function> doesn't return any value.</para>
   </refsect1>
   <refsect1>
    <title>See also</title>
    <para>
     <function>mysqli_dump_debug_info</function>,
     <function>mysqli_report</function>
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <para>
     <example>
      <title>Generating a Trace File</title>
      <programlisting role="php">
<![CDATA[
<?php
    
/* Create a trace file in '/tmp/client.trace' on the local (client) machine: */
mysqli_debug("d:t:0,/tmp/client.trace");
    
?>
]]>
      </programlisting>
     </example>
    </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
-->