SPLSUGGEST

This structure contains a pointer to a word that the spelling checker suggests as a correction for a misspelled word. This structure optionally provides a score for the suggested word to indicate the probability that the suggestion is correct.

typedef struct tagSPLSUGGEST{
WCHAR * pwsz;
DWORD nScore;} 
SPLSUGGEST, *PSPLSUGGEST;

Members

  • pwsz
    Pointer to a single suggested word in the output buffer for the spelling checker. The pwszOut member of the SPLBUFFER structure points to the beginning of this output buffer.
  • nScore
    Score of the word that pwsz points to. The spelling checker can provide this score, which indicates the likelihood of the word being correct.

Remarks

An application calls the SplSuggest function to receive up to eight suggested words from the spelling checker, which then puts these words in the output buffer pointed to by the pwszOut member of the SPLBUFFER structure. The pwsz member of SPLSUGGEST points to a single word in the output buffer.

SPLSUGGEST is the data type for the aspl member of the SPLBUFFER structure.

To get a score for each suggested word, set the SPL_SCORE_SUGGESTIONS flag using the SplOptionSet function. When this flag is not set, nScore is not valid.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.10 and later Splapi.h    

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

SPLBUFFER, SplLimitSet, SplOptionSet, SplSuggest

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.