IsMouseInPointerEnabled function

Indicates whether EnableMouseInPointer is set for the mouse to act as a pointer input device and send WM_POINTER messages.

Syntax

BOOL IsMouseInPointerEnabled(

);

Parameters

This function has no parameters.

Return Value

If EnableMouseInPointer is set, the return value is nonzero.

If EnableMouseInPointer is not set, the return value is zero.

Remarks

EnableMouseInPointer can be called only once in the context of a process lifetime. Prior to the first call, Windows Store apps run with mouse-in-pointer enabled, as do any desktop applications that consume mshtml.dll. All other desktop applications run with mouse-in-pointer disabled.

On the first call to EnableMouseInPointer in the process lifetime, the state is changed as specified and the call succeeds.

On subsequent calls to EnableMouseInPointer, the state will not change. If the current state is not equal to the specified state, the call fails.

Call IsMouseInPointerEnabled to verify the mouse-in-pointer state.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

EnableMouseInPointer

Functions

WM_POINTER