pspell_clear_session(3) php man page | unix.com

PSPELL_CLEAR_SESSION(3) 						 1						   PSPELL_CLEAR_SESSION(3)

pspell_clear_session - Clear the current session

SYNOPSIS
       bool pspell_clear_session (int  $dictionary_link)

DESCRIPTION
       pspell_clear_session(3)	clears	the  current  session.	The  current  wordlist becomes blank, and, for example, if you try to save it with
       pspell_save_wordlist(3), nothing happens.

PARAMETERS
	      o $dictionary_link
		-

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      pspell_add_to_personal(3) Example

	      <?php
	      $pspell_config = pspell_config_create("en");
	      pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
	      $pspell_link = pspell_new_config($pspell_config);

	      pspell_add_to_personal($pspell_link, "Vlad");
	      pspell_clear_session($pspell_link);
	      pspell_save_wordlist($pspell_link);    //"Vlad" will not be saved
	      ?>

PHP Documentation Group 												   PSPELL_CLEAR_SESSION(3)