mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 07:02:08 +01:00
129 lines
3.9 KiB
XML
129 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: ee741f54f831af19f135d1d9894a41477ab896c3 Maintainer: takagi Status: ready -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rarexception.setusingexceptions">
|
|
<refnamediv>
|
|
<refname>RarException::setUsingExceptions</refname>
|
|
<refpurpose>例外によるエラー処理の有効化および無効化を行う</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>RarException::setUsingExceptions</methodname>
|
|
<methodparam><type>bool</type><parameter>using_exceptions</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
引数に &true; を指定すると、UnRAR ライブラリがエラーに遭遇したときの挙動を変更し、
|
|
警告を発してエラーを示す値を返すのではなく
|
|
<type>RarException</type> 型の例外をスローするようにします。
|
|
</simpara>
|
|
<simpara>
|
|
例外は次のエラーのときにもスローされます。これらはライブラリの外部で発生します
|
|
(エラーコードは -1 です)。
|
|
</simpara>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
既に閉じた <type>RarArchive</type> オブジェクトやそれに関する <type>RarEntry</type>
|
|
オブジェクトへのアクセスを試みたとき。
|
|
</simpara>
|
|
</listitem>
|
|
|
|
<listitem>
|
|
<simpara>
|
|
存在しないエントリを <methodname>RarArchive::getEntry</methodname> で取得しようと試みたとき。
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>using_exceptions</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
例外をスローさせるときは &true;、例外をスローさせないときは &false; (デフォルト)。
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.void;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>RarException::setUsingExceptions</function> の例</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
var_dump(RarException::isUsingExceptions());
|
|
$arch = RarArchive::open("does_not_exist.rar");
|
|
var_dump($arch);
|
|
|
|
RarException::setUsingExceptions(true);
|
|
var_dump(RarException::isUsingExceptions());
|
|
$arch = RarArchive::open("does_not_exist.rar");
|
|
var_dump($arch); //not reached
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
bool(false)
|
|
|
|
Warning: RarArchive::open(): Failed to open does_not_exist.rar: ERAR_EOPEN (file open error) in C:\php_rar\trunk\tests\test.php on line 3
|
|
bool(false)
|
|
bool(true)
|
|
|
|
Fatal error: Uncaught exception 'RarException' with message 'unRAR internal error: Failed to open does_not_exist.rar: ERAR_EOPEN (file open error)' in C:\php_rar\trunk\tests\test.php:8
|
|
Stack trace:
|
|
#0 C:\php_rar\trunk\tests\test.php(8): RarArchive::open('does_not_exist....')
|
|
#1 {main}
|
|
thrown in C:\php_rar\trunk\tests\test.php on line 8
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>RarException::isUsingExceptions</methodname></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
|
|
-->
|