SetInputScope function (inputscope.h)

Article
02/22/2024

Sets an input scope for the specified window.

Syntax

HRESULT SetInputScope(
  [in] HWND       hwnd,
  [in] InputScope inputscope
);

Parameters

[in] hwnd

The window to set the scope on.

[in] inputscope

The input scope to associate with the window. To remove the input scope association, pass IS_DEFAULT to this parameter.

Return value

Value	Meaning
S_OK	The method was successful.

Remarks

Calling this method replaces whatever scope is associated with the window.

An application must call this method, passing in IS_DEFAULT to the hwnd parameter, to remove the input scope association before the window is destroyed.

This API works only when the window (hwnd parameter) and the calling thread are in the same thread. If you call this API for a different thread's window, it fails with E_INVALIDARG.

If you call this method on a window (hwnd parameter) that has not been associated with a Document Manager, then no text service notifications are sent to interested clients (such as the touch keyboard) that may want to respond to the scope change.

Examples

[C++]

The following code illustrates how to set an input scope for a window.


SetInputScope(hwnd, IS_EMAIL_USERNAME);

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	inputscope.h
DLL	Msctf.dll

Share via