Troi Text Plug-in > Functions reference > TrText_LearnSpelling
 |
TrText_LearnSpelling |
Adds a word to the spell checker dictionary.
Syntax
TrText_LearnSpelling ( switches ; wordToLearn )
Parameters
| switches | not used, reserved for future use. Leave blank or put "-Unused" |
| wordToLearn | the word to be learned |
Returned Result
Data type returned
Error code
Result
If successful the plug-in returns 0.
If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:
| 0 | No error | The word was learned. |
| $$-4221 | InvalidOSVersion | The spelling functions are not available on this platform. |
Other errors may be returned.
Originated in
Troi Text Plug-in 4.0
Compatibility
FileMaker Pro 17 to FileMaker Pro 21 (2024)
Considerations
Note that the spelling functions are available for Windows 8 and later (and all Mac OS versions).
Example
TrText_LearnSpelling ( "-Unused" ; "apekool" )This will add the word “apekool” to the dictionary of the Operating System.
Related functions
| TrText_CheckSpelling |
| TrText_SetSpellingIgnoreList |
| TrText_UnlearnSpelling |
Related script step
| Learn Spelling |
Related topics
Troi Text Plug-in online help (overview)
