Edit

Share via

IMR_DOCUMENTFEED notification code

  • Article

Notifies an application when the selected IME needs the converted string from the application. The application receives this command through the WM_IME_REQUEST message with parameters set as shown below.

LRESULT IMR_DOCUMENTFEED

Parameters

wParam

Set to IMR_DOCUMENTFEED.

lParam

Pointer to a buffer to contain the RECONVERTSTRING structure.

Return Value

Returns the current reconversion string structure. If lParam is set to NULL, the application returns the required size for the buffer to hold the structure. The command returns 0 if it does not succeed.

Remarks

The IME caches converted strings for higher conversion accuracy. One caching limitation of the IME is that it loses the converted string under the following circumstances:

  • The caret position for the application is moved by a key, for example, a cursor key.
  • The caret position for the application is moved by the mouse.
  • A new document is opened.

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

Requirements

Requirement Value
Minimum supported client
 Windows 2000 Professional [desktop apps only]
Minimum supported server
 Windows 2000 Server [desktop apps only]
Header
Imm.h (include Windows.h)

See also

Input Method Manager

Input Method Manager Commands

RECONVERTSTRING

WM_IME_REQUEST