ISpSREngineSite::SetRuleClientContext

Microsoft Speech SDK SAPI 5.1

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
);

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

Value	Description
S_OK	Function completed successfully.
SPERR_INVALID_HANDLE	Invalid rule handle parameter.
FAILED (hr)	Other appropriate error message.