ISpSREngineSite::SetRuleClientContext (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpSREngineSite::SetRuleClientContext

ISpSREngineSite::SetRuleClientContext sets an engine-defined pointer on a CFG rule.

This allows an engine to associate a pointer to its own data with each rule. This can be quickly recovered with ISpSREngineSite::GetRuleInfo.

  
    HRESULT SetRuleClientContext(
   SPRULEHANDLE   hRule,
   void          *pvClientContext
);

Parameters

  • hRule
    [in] Handle of a rule.
  • pvClientContext
    [in] Pointer to the engine's data it wishes to associate with this rule.

Return values

Value
S_OK
SPERR_INVALID_HANDLE
FAILED (hr)