pspell-config-save-repl.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.pspell-config-save-repl" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_config_save_repl</refname>
  <refpurpose>単語リストと共に置換リストを保存するかどうかを定義する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_config_save_repl</methodname>
   <methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
   <methodparam><type>bool</type><parameter>save</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pspell_config_save_repl</function> は、
   <function>pspell_save_wordlist</function> 
   が単語リストと共に置換リストを保存するかどうかを定義します。
   通常はこの関数を使用する必要はありません。なぜなら、
   <function>pspell_config_repl</function> を使用した場合は置換の組は
   <function>pspell_save_wordlist</function> により保存され、
   そうでない場合には置換の組は保存されないためです。
  </para>
  <para>
   <function>pspell_config_save_repl</function> は、
   <function>pspell_new_config</function>
   のコール前に設定を行う際に使用します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>config</parameter></term>
     <listitem>
      &pspell.parameter.pspell-config;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>save</parameter></term>
     <listitem>
      <para>
       置換リストを保存する場合に &true;、それ以外の場合に &false;。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pspell.changelog.pspell-config;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数は、pspell .11.2およびaspell .32.5 以降を有していない場合には
    動作しないことに注意してください。
   </para>
  </note>
 </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
-->