ImQueryInfoMsg

ImQueryInfoMsg

Applications can get error messages from IME.

Format:

APIRET APIENTRY ImQueryInfoMsg(HIMI hIMI, ULONG ulIndex, PSZ pBuf,
                      PULONG pulBufLen)
                      

Parameters:

hIMI(input)

- a handle of a IM Instance
ulIndex(input)
- type of message to get

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_INFOMSG_ERRLEVEL          │Error Level                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_INFOMSG_ERRINDEX          │Error index                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_INFOMSG_ERRTITLE          │Error Title                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_INFOMSG_ERRSTR            │Error message string                              │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_INFOMSG_PRIVATE           │IME private message                               │
└──────────────────────────────┴──────────────────────────────────────────────────┘

pBuf(output)
- a pointer to a message string when ulIndex is IMR_INFOMSG_ERRTITLE, IMR_INFOMSG_ERRSTR or IMR_INFOMSG_PRIVATE. When ulIndex is IMR_INFOMSG_ERRLEVEL or IMR_INFOMSG_ERRINDEX, this is reserved 0.
pulBufLen(input/output)
- (input)size, in bytes, of the string buffer when ulIndex is
IMR_INFOMSG_ERRTITLE, IMR_INFOMSG_ERRSTR or IMR_INFOMSG_PRIVATE.
(output) actual size of the string. When 0 is input in ulBufLen,
this receives size of the needed message string buffer.
When ulIndex is IMR_INFOMSG_ERRLEVEL or IMR_INFOMSG_ERRINDEX, this will be one of the following values.


When ulIndex is IMR_INFOMSG_ERRLEVEL,

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_ERROR             │Error. IME may not be able to continue.           │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_FATAL             │Fatal error. IME cannot continue. Data may be     │
│                              │lost.                                             │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_INFORMATION       │No error, but some information for users.         │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_NONE              │No error. Clear the previous message, if it's     │
│                              │still on the screen.                              │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_WARNING           │Warning for an unexpected input or other result.  │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_ERRLEVEL_HELP              │Show help message.                                │
└──────────────────────────────┴──────────────────────────────────────────────────┘

When ulIndex is IMR_INFOMSG_ERRINDEX,

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_UNSAVABLE           │The dictionary or some data cannot be saved.      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_NOCONVERT           │IME cannot convert.                               │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_NODICTIONARY        │IME cannot find the dictionary or the dictionary  │
│                              │is invalid format.                                │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_NOMODULE            │IME cannot find modules needed.                   │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_INVALIDREADING      │Reading confliction                               │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_TOOMANYSTROKES      │Too many strokes for a character or a clause      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_TYPINGERROR         │Typing error. IME cannot handle.                  │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_UNDEFINED           │Unknown error.                                    │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_INPUTREADING        │IME accepts reading character input.              │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_INPUTRADICAL        │IME accepts radical character input.              │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_INPUTCODE           │IME accepts character code input                  │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_SELECTCANDIDATE     │IME accepts candidate string selection            │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IM_INFOID_REVERSECONVERSION   │Information about reverse conversion is available.│
└──────────────────────────────┴──────────────────────────────────────────────────┘

Return:

Zero is successful. Others are errors. ERROR_BUFFER_OVERFLOW