ISpRecoContext::SetContextState
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 state of the recognition context.
Syntax
HRESULT SetContextState(
SPCONTEXTSTATE eContextState
);
Parameters
- eContextState
[in] The recognition context state. Possible values are defined for the. SPCONTEXTSTATE enumeration.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_INVALIDARG |
eContextState 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.
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |