Newton Developer Technical Information: Newton Programmer's Guide: 2.1 OS Addendum /

Chapter 5 - Spell Checker / Spell Checker Reference

Functions /

SpellUnlearn

SpellUnlearn(speller, learnedword)

Removes a word from the user's personal word list.

speller

The frame returned by the *SpellDocBegin function.

learnedword

A string containing a word to remove from the word list.

return value

Undefined; do not rely on it.

DISCUSSION

*SpellUnlearn is typically used to implement undo operations. The following example shows how *SpellUnlearn is typically used:

 learnedWord := SpellLearn(sp, word);

 SpellUnlearn(sp, learnedWord);

*SpellUnlearn should be passed the word returned by the SpellLearn call, not the original word that was passed to *SpellCheck or SpellLearn.

If you pass *SpellUnlearn a word that is not in the personal word list, there is no effect.