ImQueryCandidateList

ImQueryCandidateList

Applications can get a candidate list and the count of all of the candidate lists. Sometimes there are several candidate lists, so specify the ulIndex. If the application doesn't know the count of the lists, the application gets it by calling this with 0x ffffffff of ulIndex.

Format:

APIRET APIENTRY ImQueryCandidateList(HIMI hIMI,
                           ULONG ulIndex,
                           PCANDIDATELISTHEADER pCandidateList,
                           PULONG pulBufLen)

Parameters:

hIMI(input)

- a handle of an IM Instance
ulIndex(input)
- 0-based index of a candidate list
pCandidateList(output)
- a buffer to receive CANDIDATELISTHEADER structure
pulBufLen(input/output)
- (input)size, in bytes, of a buffer for the CANDIDATELISTHEADER
(output)
- actual size, in bytes, of CANDIDATELISTHEADER copied to the buffer. Or if the ulIndex is 0xffffffff, this pointer gets the count of all of candidate lists. If 0 is input in ulBufLen, this gets size of the candidate list specified by u Index.
Return:

Zero is successful. Others are errors.

Remarks:

See CANDIDATELISTHEADER.