pspell-clear-session.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pspell-clear-session" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_clear_session</refname>
  <refpurpose>Remet à zéro la session courante</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_clear_session</methodname>
   <methodparam><type>PSpell\Dictionary</type><parameter>dictionary</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>pspell_clear_session</function> remet à zéro la
   session courante. Le dictionnaire personnel est vidé et, par exemple,
   si vous tentez de l'enregistrer avec <function>pspell_save_wordlist</function>,
   rien ne se passera.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dictionary</parameter></term>
     <listitem>
      &pspell.parameter.pspell-dictionary;
     </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-dictionary;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>pspell_add_to_personal</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
$pspell = pspell_new_config($pspell_config);

pspell_add_to_personal($pspell, "Vlad");
pspell_clear_session($pspell);
pspell_save_wordlist($pspell);  //"Vlad" ne sera pas sauvé
?>
]]>
    </programlisting>
   </example>
  </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
-->