ISpSREngineSite::SetWordClientContext (SAPI 5.3)

  • Article

Microsoft Speech API 5.3

ISpSREngineSite::SetWordClientContext

ISpSREngineSite::SetWordClientContext sets an engine-defined context pointer on a CFG word.

This allows an engine to associate a pointer to its own data with each word. This can be quickly recovered with the ISpSREngineSite::GetWordInfo method.

  
    HRESULT SetWordClientContext(
   SPWORDHANDLE   hWord,
   void          *pvClientContext
);

Parameters

  • hWord
    [in] The handle for a word.
  • pvClientContext
    [in] Pointer to the engine's data it wishes to associate with this word.

Return values

Value
S_OK
SPERR_INVALID_HANDLE
FAILED (hr)