Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ImmGetGuideLine function

Retrieves information about errors. Applications use the information for user notifications.

Syntax


DWORD ImmGetGuideLine(
  _In_      HIMC   hIMC,
  _In_      DWORD  dwIndex,
  _Out_opt_ LPTSTR lpBuf,
  _In_      DWORD  dwBufLen
);

Parameters

hIMC [in]

Handle to the input context.

dwIndex [in]

Type of guideline information to retrieve. This parameter can have one of the following values.

ValueMeaning
GGL_LEVEL

Return the error level.

GGL_INDEX

Return the error index.

GGL_STRING

Return the error message string.

GGL_PRIVATE

Return information about reverse conversion.

 

lpBuf [out, optional]

Pointer to a buffer in which the function retrieves the error message string. This parameter contains NULL if dwIndex is not GGL_STRING or GGL_PRIVATE or if dwBufLen is set to 0.

dwBufLen [in]

Size, in bytes, of the output buffer. The application sets this parameter to 0 if the function is to return the buffer size needed to receive the error message string, not including the terminating null character.

Return value

Returns an error level, an error index, or the size of an error message string, depending on the value of the dwIndex parameter. If dwIndex is GGL_LEVEL, the return is one of the following values.

ValueMeaning
GL_LEVEL_ERRORError. The IME might not be able to continue.
GL_LEVEL_FATALFatal error. The IME cannot continue, and data might be lost.
GL_LEVEL_INFORMATIONNo error. Information is available for the user.
GL_LEVEL_NOGUIDELINENo error. Remove previous error message if still visible.
GL_LEVEL_WARNINGUnexpected input or other result. The user should be warned, but the IME can continue.

 

If dwIndex is GGL_INDEX, the return value is one of the following values.

ValueMeaning
GL_ID_CANNOTSAVEThe dictionary or the statistics data cannot be saved.
GL_ID_NOCONVERTThe IME cannot convert any more.
GL_ID_NODICTIONARYThe IME cannot find the dictionary, or the dictionary has an unexpected format.
GL_ID_NOMODULEThe IME cannot find the module that is needed.
GL_ID_READINGCONFLICTA reading conflict occurred. For example, some vowels cannot be put together to form one character.
GL_ID_TOOMANYSTROKEThere are too many strokes for one character or one clause.
GL_ID_TYPINGERRORTyping error. The IME cannot handle this typing.
GL_ID_UNKNOWNUnknown error. Refer to the error message string.
GL_ID_INPUTREADINGThe IME is accepting reading character input from the end user.
GL_ID_INPUTRADICALThe IME is accepting radical character input from the end user.
GL_ID_INPUTCODEThe IME is accepting character code input from the end user.
GL_ID_CHOOSECANDIDATEThe IME is accepting candidate string selection from the end user.
GL_ID_REVERSECONVERSIONInformation about reverse conversion is available by calling ImmGetGuideLine, specifying GGL_PRIVATE. The information retrieved is in CANDIDATELIST format.

 

If dwIndex is GGL_STRING, the return value is the number of bytes of the string copied to the buffer. However, if dwBufLen is 0, the return value is the buffer size needed to receive the string, not including the terminating null character. For Unicode, if dwBufLen is 0, the return value is the size, in bytes not including the Unicode terminating null character.

If dwIndex is GGL_PRIVATE, the return value is the number of bytes of information copied to the buffer. If dwIndex is GGL_PRIVATE and dwBufLen is 0, the return value is the buffer size needed to receive the information.

Remarks

Applications typically call this function after receiving an IMN_GUIDELINE command.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Version

East Asian language support installed.

Header

Imm.h (include Windows.h)

Library

Imm32.lib

DLL

Imm32.dll

Unicode and ANSI names

ImmGetGuideLineW (Unicode) and ImmGetGuideLineA (ANSI)

See also

Input Method Manager
Input Method Manager Functions
CANDIDATELIST
IMN_GUIDELINE

 

 

Community Additions

ADD
Show:
© 2015 Microsoft