Microsoft Speech SDK
SAPI 5.1
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 | Description |
|---|---|
| S_OK | Function completed successfully. |
| E_POINTER | pWordEntry points to invalid memory. |
| E_INVALIDARG | Either invalid pWordEntry->hWord word handle or Options contains invalid flags. |
| E_OUTOFMEMORY | Not enough memory to complete the operation. |
| FAILED (hr) | Appropriate error message. |