ImGetResultString

ImGetResultString

Applications can get information about result string.

Format:

APIRET APIENTRY ImGetResultString(HIMI hIMI, ULONG ulIndex,
                                    PVOID pBuf, PULONG pulBufLen)
                                    

Parameters:

hIMI(input)

- a handle of a IM Instance associated with a conversion string
ulIndex(input)
- index of information to query

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_RESULTSTRING       │Gets a result string. Output is a 0-terminated    │
│                              │string.                                           │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_RESULTATTR         │Gets an attribute of the result string.           │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_RESULTCLAUSE       │Gets clause information of the result string      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_READINGSTRING      │Gets a reading string of the result string. Output│
│                              │is a 0-terminated string.                         │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_READINGATTR        │Gets an attribute of the reading  string. The     │
│                              │attribute will be RP_ATTR_INTERIM which means it's│
│                              │an interim string, or RP_ATTR_RESULT which means  │
│                              │it's a result string.                             │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│IMR_RESULT_READINGCLAUSE      │Gets clause information of the reading string     │
└──────────────────────────────┴──────────────────────────────────────────────────┘

Please refer to ImGetConversionString about the clause information.

pBuf(output)
- a buffer to be copied the information into
pulBufLen(input/output)
- (input)size, in bytes, of the buffer (output) actual size of data copied to the buffer. If 0 is input in ulBufLen, this gets size of buffer to get full information.
Return:

Zero is successful. Others are errors.

Remarks:

This API causes no change of information in the IM Instance. When level-3 application call this function, it must not send the corresponding WM_IMEREQUEST message to the default IM window.