ImRequestIME

ImRequestIME

Applications can make some requests to IME .

Format:

APIRET APIENTRY ImRequestIME(HIMI hIMI, ULONG ulAction, ULONG ulIndex,
                    ULONG ulValue)
                    

Parameters:

hIMI(input)

- a handle of a IM Instance
ulAction(input)
- type of request to IME

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_CHANGECANDIDATELIST       │Changes the current selected candidate. ulIndex is│
│                              │an index of the current candidate list. ulValue is│
│                              │not used.                                         │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_CLOSECANDIDATE            │Closes a candidate list. ulIndex is an index of   │
│                              │the candidate list. ulValue is not used.          │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_CONVERSIONSTRING          │ulIndex is one of the following. CNV_CANCEL,      │
│                              │CNV_COMPLETE, CNV_CONVERT, CNV_REVERT ulValue is  │
│                              │not used.                                         │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_OPENCANDIDATE             │Opens a candidate list. ulIndex is an index of the│
│                              │candidate list. ulValue is not used.              │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_SELECTCANDIDATE           │Selects one of candidates. ulIndex is an index of │
│                              │a candidate list to be selected. ulValue is an    │
│                              │index of the candidate string in the list.        │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_SETCANDIDATEPAGESIZE      │Sets page size of a candidate list. ulIndex is an │
│                              │index of the candidate list.                      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│REQ_SETCANDIDATEPAGESTART     │ulIndex is an index of the candidate list.        │
└──────────────────────────────┴──────────────────────────────────────────────────┘

ulIndex(input)
- index of a candidate list. Or when ulAction is REQ_CONVERSIONSTRING, this is one of the following.

┌──────────────────────────────┬──────────────────────────────────────────────────┐
│Type                          │Description                                       │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│CNV_CANCEL                    │Clears the conversion string                      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│CNV_COMPLETE                  │Completes the conversion, sets the conversion     │
│                              │string as the result string.                      │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│CNV_CONVERT                   │Converts the conversion string.                   │
├──────────────────────────────┼──────────────────────────────────────────────────┤
│CNV_REVERT                    │Cancels the current conversion string and revert  │
│                              │to the unconverted string.                        │
└──────────────────────────────┴──────────────────────────────────────────────────┘

ulValue(input)
- When ulAction is REQ_SELECTCANDIDATE, this is index of a candidate string.
Return:

Zero is successful. Others are errors.