ISpSREngine::SetProprietaryRuleIdState (Windows Embedded CE 6.0)
1/6/2010
This method sets the state of the identifier for a proprietary grammar rule. It is used to start or stop rules in nonstandard proprietary grammars, for which each rule is represented by an identifier.
Syntax
HRESULT SetProprietaryRuleIdState(
void* pvEngineGrammar,
DWORD dwRuleId,
SPRULESTATE NewState
);
Parameters
- pvEngineGrammar
[in] Pointer to the grammar for the engine, as retrieved from a prior call to the ISpSREngine::OnCreateGrammar method.
- dwRuleId
[in] Identifier for the proprietary grammar rule.
- NewState
[in] Grammar rule state. Possible values are defined for the SPRULESTATE 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 |