ISpSREngine::SetSLMState

Microsoft Speech SDK SAPI 5.1

ISpSREngine::SetSLMState activates or deactivates dictation on this grammar.

HRESULT SetSLMState(
   void         *pvEngineGrammar,
   SPRULESTATE   NewState
);

pvEngineGrammar: [in] The engine's grammar pointer for this grammar, as returned from a previous call to the OnCreateGrammar method.
NewState: [in] One of the grammar rule states specified in the SPRULESTATE enumeration sequence. This can be SPRS_ACTIVE to indicate that dictation is being activated; SPRS_INACTIVE to indicate dictation is being deactivated, and SPRS_ACTIVE_WITH_AUTO_PAUSE to indicate dictation is being activated with auto-pause This means that the engine will be put into the paused state each time it returns a final recognition result on this grammar. This is just for information and can be handled in the same way as SPRS_ACTIVE.

Value	Description
S_OK	Function completed successfully.
FAILED(hr)	Appropriate error message.