ISpSREngineSite::SetWordClientContext (Windows Embedded CE 6.0)
1/6/2010
This method sets an engine-defined context pointer on a CFG word. The method allows an engine to associate a pointer to its own data with each word. The data can be quickly recovered with the ISpSREngineSite::GetWordInfo method.
Syntax
HRESULT SetWordClientContext(
SPWORDHANDLE hWord,
void* pvClientContext
);
Parameters
- hWord
[in] Handle to a CFG word.
- pvClientContext
[in] Pointer to the engine data to associate with the word.
Return Value
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
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |