<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.rarexception" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The RarException class</title>
 <titleabbrev>RarException</titleabbrev>

 <partintro>

<!-- {{{ RarException intro -->
  <section xml:id="rarexception.intro">
   &reftitle.intro;
   <para>
    This class serves two purposes: it is the type of the exceptions thrown by the RAR extension
    functions and methods and it allows, through static methods to query and define the error
    behaviour of the extension, i.e., whether exceptions are thrown or only warnings are emitted.
   </para>
   <para>
    The following error codes are used:
   </para>
   <itemizedlist>
    <listitem>
     <simpara>
      -1 - error outside UnRAR library
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      11 - insufficient memory
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      12 - bad data
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      13 - bad archive
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      14 - unknown format
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      15 - file open error
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      16 - file create error
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      17 - file close error
     </simpara>
    </listitem>
    
    <listitem>
     <simpara>
      18 - read error
     </simpara>
    </listitem>
     <listitem>
     <simpara>
      19 - write error
     </simpara>
    </listitem>
 
    <listitem>
     <simpara>
      20 - buffer too small
     </simpara>
    </listitem>
 
    <listitem>
     <simpara>
      21 - unknown RAR error
     </simpara>
    </listitem>
 
    <listitem>
     <simpara>
      22 - password required but not given
     </simpara>
    </listitem>
   </itemizedlist>
  </section>
<!-- }}} -->

  <section xml:id="rarexception.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>RarException</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>final</modifier>
      <classname>RarException</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>Exception</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>

 </partintro>

 &reference.rar.entities.rarexception;

</phpdoc:classref>

<!-- 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
-->
