This function gets the property and capabilities of the IME associated with the specified keyboard layout.
At a Glance
| Header file: | Imm.h |
| Windows CE versions: | 2.10 and later (Japanese version 1.0 and later) |
Syntax
BOOL ImmGetProperty(HKL hKL, DWORD fdwIndex);
Parameters
hKL
[in] Ignored; set to NULL. Windows CE does not support true keyboard layouts.
fdwIndex
[in] Specifies the type of property information to retrieve. This parameter can be one of the following values:
| Value | Description |
| IGP_PROPERTY | Property information. |
| IGP_CONVERSION | Conversion capabilities. |
| IGP_SENTENCE | Sentence mode capabilities. |
| IGP_UI | User interface capabilities. |
| IGP_SETCOMPSTR | Composition string capabilities. |
| IGP_SELECT | Selection inheritance capabilities. |
| IGP_GETIMEVERSION | Unsupported. |
Return Values
Returns the property or capability value, depending on the value of the dwIndex parameter. If dwIndex is IGP_PROPERTY, returns a combination of the following values:
IME_PROP_AT_CARET
If set, conversion window is at the caret position. If clear, the window is near caret position.
IME_PROP_SPECIAL_UI
If set, IME has a nonstandard user interface. The application should not draw in the IME window.
IME_PROP_CANDLIST_START_FROM_1
If set, strings in the candidate list are numbered starting at 1. If clear, strings start at 0.
IME_PROP_UNICODE
If set, strings for the input context have Unicode characters. If clear, strings have single and double-byte characters.
IME_PROP_COMPLETE_ON_UNSELECT
If set, the IME will complete the composition string when the IME is deactivated. If clear, the IME will cancel the composition string when the IME is deactivated (such as from a keyboard layout change).
If dwIndex is IGP_UI, the return value is a combination of the following values:
| Value | Description |
| UI_CAP_2700 | Supports text escapement values of 0 or 2700. |
| UI_CAP_ROT90 | Supports text escapement values of 0, 900, 1800, or 2700. |
| UI_CAP_ROTANY | Supports any text escapement value. |
If dwIndex is IGP_SETCOMPSTR, the return value is a combination of the following values:
| Value | Description |
| SCS_CAP_COMPSTR | Can create the composition string by using the SCS_SETSTR value of the ImmSetCompositionString function. |
| SCS_CAP_MAKEREAD | Can create the reading string from corresponding composition string when using the SCS_SETSTR value of the ImmSetCompositionString function. |
If dwIndex is IGP_SELECT, the return value is a combination of the following values:
| Value | Description |
| SELECT_CAP_CONVMODE | Inherits conversion mode when a new IME is selected. |
| SELECT_CAP_SENTENCE | Inherits sentence mode when a new IME is selected. |
If dwIndex is IGP_GETIMEVERSION, the return value is one of the following values:
| Value | Description |
| IMEVER_0310 | The IME was created for Windows 3.1 |
| IMEVER_0400 | The IME was created for Windows 95. |