Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This method sets an engine-defined pointer on a CFG rule. The method allows an engine to associate a pointer to its own data with each rule. The data can be quickly recovered with the ISpSREngineSite::GetRuleInfo method.
HRESULT SetRuleClientContext( SPRULEHANDLE hRule, void* pvClientContext);
Parameters
- hRule
[in] Handle to a CFG rule. - pvClientContext
[in] Pointer to the engine data to associate with the rule.
Return Values
The following table shows the possible return values.
| Value | Description |
|---|---|
| S_OK | Function completed successfully. |
| SPERR_INVALID_HANDLE | Invalid rule handle argument. |
| FAILED(hr) | Other appropriate error message. |
Requirements
OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.
See Also
ISpSREngineSite | SAPI Interfaces
Send Feedback on this topic to the authors