Export (0) Print
Expand All

WINNLSEnableIME function

Temporarily enables or disables an Input Method Editor (IME) and, at the same time, turns on or off the display of all windows owned by the IME.

Note  This function is obsolete and should not be used.

Syntax


BOOL WINAPI WINNLSEnableIME(
  _In_  HWND hwnd,
  _In_  BOOL bFlag
);

Parameters

hwnd [in]

Must be NULL. Specifying a particular IME for each application is not supported.

bFlag [in]

TRUE to enable the IME; FALSE to disable.

Return value

The previous state of the IME. TRUE if it was enabled before this call, otherwise, FALSE.

Remarks

The terms "enabled" and "disabled" in regard to this function are defined as follows:

If an IME is disabled, IME_WINDOWUPDATE(FALSE) is issued to the IME, which responds by deleting the conversion and system windows. With the IME disabled, keyboard messages are not sent to the IME, but are sent directly to the application. Even if the IME is disabled, the API that uses the SendIMEMessageEx function is still valid.

If an IME is enabled, IME_WINDOWUPDATE(TRUE) is issued to the IME, which responds by redisplaying the conversion and system windows. With the IME enabled, keyboard messages are sent to the IME.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winnls32.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft