ISpSREngine::SetContextState

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpSREngine::SetContextState

ISpSREngine::SetContextState indicates that a recognition context has been activated or deactivated by the application calling ISpRecoContext::SetContextState.

HRESULT SetContextState(
  void          * pvEngineContext,
  SPCONTEXTSTATE  eContextState
);

Parameters

pvEngineContext
[in] Pointer to the engine's data for this context, as returned from a previous call to OnCreateRecoContext.
eContextState
[in] The SPCONTEXTSTATE enumeration value specifying the new recognition context state.

Return values

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

Remarks

When using standard CFG and dictation grammars, the engine may not need to be informed of the context state, as SAPI will automatically activate and deactivate the grammars as necessary. However, when using proprietary grammars, it may be necessary to look at this information.