SplCheck

This function is called by an application to notify the spelling checker to look for errors in a text buffer.

At a Glance

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

Syntax

int SplCheck( HSPL hspl, SPLBUFFER * psb,);

Parameters

hspl

Handle to the spelling session. An application initiates a spelling session by calling the SplInit function, which then generates this handle.

psb

Pointer to the SPLBUFFER structure that contains the string to be checked.

Return Values

1 indicates success. 0 indicates failure.

Remarks

Before using SplCheck, an application must initialize the spelling session with the SplInit function and can set options with the SplOptionSet function. An application can specify the spelling checker’s behavior using the SplOptionSet, SplSuggest, and SplReplace functions.

After each call to SplCheck, an application checks SPLBUFFER for results and sets the SPLBUFFER members to specify where in the input buffer the spelling checker resumes checking with the next SplCheck call.