ISpRecoContext::SetContextState (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3

ISpRecoContext::SetContextState

ISpRecoContext::SetContextState sets the state of the recognition context.

HRESULT SetContextState(
   SPCONTEXTSTATE   eContextState
);

Parameters

eContextState
[in] The SPCONTEXTSTATE enumeration sequence specifying the recognition context state.

Return values

ValueDescription
S_OKFunction completed successfully.
E_INVALIDARGeContextState is not one of the correct types.
FAILED(hr)Appropriate error message.

Remarks

The default recognition context state for an ISpRecoContext object is SPCS_ENABLED.

Applications can use ISpRecoContext::SetContextState to toggle sets of grammars. For example, a multi-document interface application that uses a different ISpRecoContext object for each document could toggle the context states as each document gained and lost the focus.  

Applications can use ISpRecoContext::GetContextState to query the context state.

Show: