ISpSREngineSite::GetWordInfo (Windows CE 5.0)
This method gets information about a word in a CFG.
HRESULT GetWordInfo( SPWORDENTRY* pWordEntry, SPWORDINFOOPT Options);
Parameters
- pWordEntry
[in, out] Pointer to an SPWORDENTRY structure containing grammar word entry information. Only the word handle in the hWord member needs to be set. The pszDisplayText, pszLexicalForm, and aPhoneId members can be allocated with CoTaskMemAlloc. If these members are allocated, each must each be freed with CoTaskMemTaskFree when no longer required. - Options
[in] A grammar word option. Possible options are defined for the SPWORDINFOOPT enumeration. If the SPWIO_NONE option is used, the LangID and pvClientContext members are filled in the structure passed by pWordEntry. If the SPWIO_WANT_TEXT option is provided, all the members of the structure are filled in.
Return Values
The following table shows the possible return values.
| Value | Description |
|---|---|
| S_OK | Function completed successfully. |
| E_POINTER | pWordEntry points to invalid memory. |
| E_INVALIDARG | Either invalid word handle in SPWORDENTRY structure, or invalid flags in the Options parameter. |
| E_OUTOFMEMORY | Not enough memory to complete the operation. |
| FAILED(hr) | 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