IMR_DOCUMENTFEED

The IMR_DOCUMENTFEED command is sent when the selected IME needs the converted string from the application.

The application receives this command through the WM_IME_REQUEST message with wParam and lParam set as follows.

Parameters

wParam

Set to IMR_DOCUMENTFEED.

lParam

Pointer to a buffer to contain the reconversion string structure.

Return Values

If lParam is NULL, the application must return the required size of the RECONVERTSTRING. If the application filled the RECONVERTSTRING structure in lParam, return the required size of the RECONVERTSTRING structure. Otherwise return zero.

Remarks

The IME caches converted strings for higher conversion accuracy. There are, however, some limitations to caching converted strings because the IME loses the corrected converted string under the following circumstances:

• When the application's caret position is moved by a key such as the cursor keys.
• When the application's caret position is moved by the mouse.
• When a new document is opened.

With the IMR_DOCUMENTFEED command, the IME can refresh its cached strings any time. This improves conversion accuracy.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in Imm.h.

See Also

Input Method Editor Overview, Input Method Editor Commands, WM_IME_REQUEST, RECONVERTSTRING