ISpSREngine::SetGrammarState
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets the grammar state. SAPI calls the method when a grammar has been stopped or started by the application calling ISpRecoGrammar::SetGrammarState.
For standard CFG and dictation grammars, the engine might not need to take any account of the grammar state, as SAPI automatically activates and deactivates the contents of the grammar as necessary. However, for proprietary grammars the engine might need to look at the grammar state.
Syntax
HRESULT SetGrammarState(
void* pvEngineGrammar,
SPGRAMMARSTATE* eGrammarState
);
Parameters
- pvEngineGrammar
[in] Pointer to the grammar for the engine. It is retrieved by a prior call to the ISpSREngine::OnCreateGrammar method.
- eGrammarState
[in] Pointer to the new state of the grammar. Possible values are defined for the SPGRAMMARSTATE enumeration.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |