Share via


ISpSREngineSite::GetWordInfo (SAPI 5.3)

Microsoft Speech API 5.3

ISpSREngineSite::GetWordInfo

ISpSREngineSite::GetWordInfo retrieves information about a word in a CFG grammar.

  
    HRESULT GetWordInfo(SPWORDENTRY    *pWordEntry,
SPWORDINFOOPT   Options
);

Parameters

  • pWordEntry
    [in, out] Address of the SPWORDENTRY structure that contains the grammar word entry information. This can be called with only the pWordEntry->hWord word handle set. The following members may be allocated with CoTaskMemAlloc() and if so, each must be freed by the engine with CoTaskMemTaskFree() when no longer required.

    pWordEntry->pszDisplayText
    pWordEntry->pszLexicalForm
    pWordEntry->aPhoneId
  • Options
    [in] One of the grammar word options specified in the SPWORDINFOOPT enumeration. If SPWIO_NONE, the LangID and pvClientContext are filled in. If SPWIO_WANT_TEXT, the display and lexical text and pronunciation are also filled in.

Return values

Value
S_OK
E_POINTER
E_INVALIDARG
E_OUTOFMEMORY
FAILED (hr)