ISpSREngine::WordNotify (Windows Embedded CE 6.0)
1/6/2010
This method notifies the SR engine when words in command and control grammars are being added or removed. This method is called by SAPI when an application loads, unloads, or modifies grammars. SAPI internally keeps a reference count so that each word will only be added if it is not already present in any existing grammar.
Syntax
HRESULT WordNotify(
SPCFGNOTIFY Action,
ULONG cWords,
const SPWORDENTRY* pWords
);
Parameters
- Action
[in] Action that is occurring. Possible values are defined for the SPCFGNOTIFY enumeration. Currently the value must be either SPCFGN_ADD when words are added, or SPCFGN_REMOVE when they are deleted.
- cWords
[in] Number of words specified by pWords.
- pWords
[in] Pointer to an array of SPWORDENTRY structures containing information about the words.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
SPERR_NO_WORD_PRONUNCIATION |
The engine could not generate a pronunciation for some of the words added. |
FAILED(hr) |
Other appropriate error message. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |