AIT_IMEGetProperty

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.

ValueDescription
IGP_PROPERTYProperty information
IGP_CONVERSIONConversion functionality
IGP_SENTENCESentence mode functionality
IGP_UIUser interface functionality
IGP_SETCOMPSTRComposition character string functionality
IGP_SELECTSelection 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.

ValueDescription
IME_PROP_AT_CARETWith this value on, the conversion window is at the caret position. If not, it is near the caret.
IME_PROP_SPECIAL_UIWith 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_1With 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_UNICODEWith 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.

ValueDescription
UI_CAP_2700Supports a value of 0 or 2700 as the text printing direction.
UI_CAP_ROT90Supports values of 0, 900, 1800, and 2700 as the text printing direction.
UI_CAP_ROTANYSupports any printing direction.

If nPropertyInfo is IGP_SETCOMPSTR, the return value is a combination of the values below.

ValueDescription
SCS_CAP_COMPSTRYou can use the SCS_SETSTR value of IMESetCompositionString to create a composition character string.
SCS_CAP_MAKEREADYou 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.

ValueDescription
SELECT_CAP_CONVERSIONInherits conversion mode if a new IME has been selected.
SELECT_CAP_SENTENCEInherits 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 numberError code
87ERROR_INVALID_PARAMETER