ImConvertString

ImConvertString

Applications can convert any strings by using IME conversion engine.

Format:

APIRET APIENTRY ImConvertString(HIMI hIMI, PSZ pSrc,
                                PCANDIDATELISTHEADER pDst,
                                PULONG pulBufLen, ULONG ulFlag)
                                

Parameters:

hIMI(input)

- a handle of a IM Instance
pSrc(input)
- a pointer to a string to be converted
pDst(output)
- a bufferto be copied CANDIDATELISTHEADER into
pulBufLen(input/output)
- (input)size, in bytes, of the buffer for the CANDIDATELISTHEADER
(output)
- actual size of CANDIDATELISTHEADER to be copied into the buffer, or when ulBufLen is 0, this is necessary size of CANDIDATELIST to be copied.
ulFlag
- type of conversion

┌───────────────┬────────────────────────────────────────┐
│Type           │Description                             │
├───────────────┼────────────────────────────────────────┤
│CNV_NORMAL     │The source string, pSrc, is a reading   │
│               │string. And this function copies a      │
│               │result string to the destination        │
│               │buffer,pDst.                            │
├───────────────┼────────────────────────────────────────┤
│CNV_REVERSE    │The source string is a result string,   │
│               │and the desitination is a reading       │
│               │string.                                 │
├───────────────┼────────────────────────────────────────┤
│CNV_READLEN    │The source string is a result string.   │
│               │This function returns size of the       │
│               │reading string into pulSize.            │
└───────────────┴────────────────────────────────────────┘

Return:

Zero is successful. Others are errors.

Remarks:

See CANDIDATELISTHEADER