php-doc-en/reference/maxdb/functions/maxdb-debug.xml
2012-01-11 06:50:17 +00:00

89 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-debug">
<refnamediv>
<refname>maxdb_debug</refname>
<refpurpose>Performs debugging operations</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>maxdb_debug</methodname>
<methodparam><type>string</type><parameter>debug</parameter></methodparam>
</methodsynopsis>
<para>
The <function>maxdb_debug</function> can be used to trace the SQLDBC communication. The following
strings can be used as a parameter to <function>maxdb_debug</function>:
</para>
<simplelist>
<member>TRACE SHORT ON|OFF - Enables/disables method call trace.</member>
<member>TRACE LONG ON|OFF - Enables/disables method argument and detail debug trace.</member>
<member>TRACE PACKET ON|OFF|&#x3c;size&#x3e; - Enables/disables packet trace, limiting the size of the
traced object to the specified number of bytes, or 1000 if no size is specified.</member>
<member>TRACE SQL ON|OFF - Enables/disables high level api trace.</member>
<member>TRACE TIMESTAMP ON|OFF - Enables/disables a timestamp prefix on each line that is
traced.</member>
<member>TRACE SIZE &#x3c;size&#x3e; - Limits the size of the trace file to &#x3c;size&#x3e; bytes,
at least 8192 bytes are required.</member>
</simplelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>maxdb_debug</function> doesn't return any value.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
maxdb_debug("trace packet 200");
$link = maxdb_connect("localhost", "MONA", "RED", "DEMODB");
/* check connection */
if (!$link) {
printf("Connect failed: %s\n", maxdb_connect_error());
exit();
}
/* close connection */
maxdb_close($link);
?>
]]>
</programlisting>
</example>
<para>
The above example produces no output.
</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:"~/.phpdoc/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
-->