SplRemUserDict

This function removes a word from an internal or external user dictionary.

At a Glance

Header file:	Splapi.h
Windows CE versions:	2.10 and later

Syntax

int SplRemUserDict ( HSPL hspl, int nID, const WCHAR * pwsz );

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 user dictionary.

pwsz

Pointer to a string that contains the word to remove from the dictionary.

Return Values

1 indicates success. 0 indicates failure.

Remarks

Words cannot be removed from the main dictionary.

When an application calls SplQuit, which ends a spelling session, the three internal user dictionaries are removed from memory; therefore, changes to those dictionaries affect the current spelling session only. Changes to external user dictionaries are saved for use during future spelling sessions.