<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="tidy.props.errorbuffer" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>tidy::$errorBuffer</refname>
  <refname>tidy_get_error_buffer</refname>
  <refpurpose>Return warnings and errors which occurred parsing the specified document</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop; (property):</para>
  <fieldsynopsis><modifier>public</modifier> <type>string</type><varname linkend="tidy.props.errorbuffer">tidy-&gt;errorBuffer</varname></fieldsynopsis>
  <para>&style.procedural;:</para>
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>tidy_get_error_buffer</methodname>
   <methodparam><type>tidy</type><parameter>tidy</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns warnings and errors which occurred parsing the specified document.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>tidy</parameter></term>
     <listitem>
      <para>
       &tidy.object;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the error buffer as a string, or &false; if the buffer is empty.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>tidy_get_error_buffer</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$html = '<p>paragraph</p>';

$tidy = tidy_parse_string($html);

echo tidy_get_error_buffer($tidy);
/* or in OO: */
echo $tidy->errorBuffer;
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
line 1 column 1 - Warning: missing <!DOCTYPE> declaration
line 1 column 1 - Warning: inserting missing 'title' element
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>tidy_access_count</function></member>
   <member><function>tidy_error_count</function></member>
   <member><function>tidy_warning_count</function></member>
  </simplelist>
 </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
-->
