SplClrUserDict

This function clears the contents of an internal or external user dictionary. The main dictionary cannot be cleared.

int SplClrUserDict( 
HSPL hspl, 
int nID );

Parameters

• hspl
  Handle to the spelling session. An application initiates a spelling session by calling the SplInit function, which then generates this handle.
• nID
  Identifier of the spelling dictionary to be removed.

Return Values

1 indicates success. 0 indicates failure.

Remarks

SplClrUserDict provides a means to clear internal and external user dictionaries that are not relevant to text that is currently being checked. Removing an internal user dictionary may be necessary if an application initializes the spelling checker when the application starts. In this case, the spelling checker maintains the internal user dictionaries throughout the spelling session until the application exits. An application may want to clear the contents of an internal dictionary when more than one document is checked for spelling during a single execution of an application.

When an application calls SplQuit, which ends a spelling session, all three internal user dictionaries are removed from memory.

Requirements

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

SplAddUserDict, SplInit, SplQuit, SplRemUserDict

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.