ImmGetGuideLine (Windows CE 5.0)

Send Feedback

This function gets information about errors. Applications use the information to notify users.

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


  • hIMC
    [in] Handle to the input context.
  • dwIndex
    [in] Value that specifies the type of guideline information to retrieve. The following table shows the values this parameter can take.
    Value Description
    GGL_LEVEL Returns the error level.
    GGL_INDEX Returns the error index.
    GGL_STRING Retrieves the error message string.
    GGL_PRIVATE Returns information about reverse conversion.
  • lpBuf
    [out] Long pointer to the buffer that receives the error message string. This parameter can be NULL if dwIndex is not GGL_STRING or GGL_PRIVATE if dwBufLen is zero.
  • dwBufLen
    [in] Size, in bytes, of the buffer pointed to by lpBuf. If zero, the function returns the buffer size needed to receive the error message string, not including the terminating null character.

Return Values

The return value is an error level, an error index, or the size of an error message string, depending on the value of the dwIndex parameter. The following table shows the values if dwIndex is GGL_LEVEL.

Value Description
GL_LEVEL_ERROR Error. The IME may not be able to continue.
GL_LEVEL_FATAL Fatal error. The IME cannot continue, and data may be lost.
GL_LEVEL_INFORMATION No error, but information is available for the user.
GL_LEVEL_NOGUIDELINE No error. Remove previous error message if still visible.
GL_LEVEL_WARNING Unexpected input or other result. The user should be warned, but the IME can continue.

The following table shows the values if dwIndex is GGL_INDEX.

Value Description
GL_ID_CANNOTSAVE The dictionary or the statistics data cannot be saved.
GL_ID_NOCONVERT The IME cannot convert any more.
GL_ID_NODICTIONARY The IME cannot find the dictionary, or the dictionary has an unexpected format.
GL_ID_NOMODULE The IME cannot find the module that IME needs.
GL_ID_READINGCONFLICT For example, some vowels cannot put together.
GL_ID_TOOMANYSTROKE There are too many strokes for one character or one clause.
GL_ID_TYPINGERROR Typing error. The IME cannot handle this typing.
GL_ID_UNKNOWN Unknown error. The application should refer to the error message string.
GL_ID_INPUTREADING IME accepts reading character input.
GL_ID_INPUTRADICAL IME accepts radical character input.
GL_ID_INPUTCODE IME accepts character code input.
GL_ID_CHOOSECANDIDATE IME accepts candidate string selection.
GL_ID_REVERSECONVERSION Information about reverse conversion is available.

If dwIndex is GGL_STRING, the return value is the number of bytes of the string copied to the buffer, or, if dwBufLen is zero, the return value is the buffer size needed to receive the string.

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 zero, the return value is the buffer size needed to receive the information.


Applications typically call this function after receiving an IMN_GUIDELINE message.


OS Versions: Windows CE .NET 4.0 and later.
Header: Imm.h.
Link Library: Coreimm.lib.

See Also


Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.