AIT_IMEGetProperty
- Organization of this page
Description
Acquires IME properties or functionalities associated with an input focus window.
Format
integer AIT_IMEGetProperty ( integer nPropertyInfo // Property information );
Parameters
nPropertyInfo (input)
Specify property information you want to acquire. You have to set one of the following values.
|
Value |
Description |
|---|---|
|
IGP_PROPERTY |
Property information |
|
IGP_CONVERSION |
Conversion functionality |
|
IGP_SENTENCE |
Sentence mode functionality |
|
IGP_UI |
User interface functionality |
|
IGP_SETCOMPSTR |
Composition character string functionality |
|
IGP_SELECT |
Selection inheritance functionality |
Return values
The value returned if the function was executed normally is the property or functionality value corresponding to the nPropertyInfo value. In the other cases, the return value is -1.
The value returned if nPropertyInfo is IGP_PROPERTY is a combination of the following values.
|
Value |
Description |
|---|---|
|
IME_PROP_AT_CARET |
With this value on, the conversion window is at the caret position. If not, it is near the caret. |
|
IME_PROP_SPECIAL_UI |
With this value on, the IME has no standard user interface. In this case, do not use the application to draw in the IME window. |
|
IME_PROP_CANDLIST_START_FROM_1 |
With this value on, the character strings in a candidate list are numbered in sequence beginning with 1. If not, they are numbered in sequence beginning with 0. |
|
IME_PROP_UNICODE |
With this value on, the input context character string contains Unicode characters. If not, it contains one- and two-byte characters. |
If nPropertyInfo is IGP_UI, the return value is a combination of the following values.
|
Value |
Description |
|---|---|
|
UI_CAP_2700 |
Supports a value of 0 or 2700 as the text printing direction. |
|
UI_CAP_ROT90 |
Supports values of 0, 900, 1800, and 2700 as the text printing direction. |
|
UI_CAP_ROTANY |
Supports any printing direction. |
If nPropertyInfo is IGP_SETCOMPSTR, the return value is a combination of the values below.
|
Value |
Description |
|---|---|
|
SCS_CAP_COMPSTR |
You can use the SCS_SETSTR value of IMESetCompositionString to create a composition character string. |
|
SCS_CAP_MAKEREAD |
You can use the SCS_SETSTR value of IMESetCompositionString to create a read character string from the appropriate composition character string. |
If nPropertyInfo is IGP_SELECT, the return value is a combination of the values below.
|
Value |
Description |
|---|---|
|
SELECT_CAP_CONVERSION |
Inherits conversion mode if a new IME has been selected. |
|
SELECT_CAP_SENTENCE |
Inherits sentence mode if a new IME has been selected. |
If the function has returned -1, you can use AIT_GetLastError to acquire an extended error code.
The following gives the error code that AIT_GetLastError might return:
|
Extended error number |
Error code |
|---|---|
|
87 |
ERROR_INVALID_PARAMETER |