ISpSREngine::SetProprietaryRuleIdState (Windows CE 5.0)

Send Feedback

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.

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 Values

The following table shows the possible return values.

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

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.

See Also

ISpSREngine | SAPI Interfaces

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.