ISpRecoGrammar2::SetRulePriority (SAPI 5.4)

Microsoft Speech API 5.4

ISpRecoGrammar2::SetRulePriority

ISpRecoGrammar2::SetRulePriority sets the priority on the specified rule.

  
    HRESULT SetRulePriority(
   LPCWSTR    pszRuleName,
   ULONG      ulRuleId,
   int        nRulePriority
);

Parameters

  • pszRuleName
    The name of the rule.
  • ulRuleId
    The ID number of the rule.
  • nRulePriority
    The priority to be assigned to the rule (between -128 and + 127). When a given utterance satisfies more than one rule, the recognizer applies the rule with the highest priority. When an utterance satisfies several rules with the same priority, or several rules with no priority, the recognizer applies the most recently activated rule.

Return values

Value
S_OK
E_INVALIDARG
FAILED(hr)

Remarks

Be sure that you use the correct letter casing when specifying the rule name. Rule names are case-sensitive in SAPI. For example, if the name of the rule to target is "Test", and you set the value of pszRuleName to "test", the call will generate an error or incorrectly target a rule named "test".

  • Last updated on