SplReplace

This function offers a suggestion that an application can use to automatically replace a misspelled word. An application that implements an inline spelling checker with an automatic replacement feature can use this function to automatically correct errors as a user inputs words.

At a Glance

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

Syntax

int SplReplace( 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 for the checked word.

Return Values

1 indicates success. 0 indicates failure.

Remarks

To use SplReplace, an application must set a replacement error tolerance by calling the SplLimitSet function.

SplReplace combines the processing abilities of the SplCheck and SplSuggest functions for use in an inline spelling checker with an automatic replacement feature.

See Also

SPLBUFFER, SplCheck, SplInit, SplLimitSet, SplSuggest