Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 3.64 KB

nf-winuser-unregisterpointerinputtarget.md

File metadata and controls

87 lines (68 loc) · 3.64 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winuser.UnregisterPointerInputTarget
UnregisterPointerInputTarget function (winuser.h)
Allows the caller to unregister a target window to which all pointer input of the specified type is redirected.
UnregisterPointerInputTarget
UnregisterPointerInputTarget function [Windows Accessibility]
inputmsg.getactivepointers
winauto.unregisterpointerinputtarget
winuser/UnregisterPointerInputTarget
winauto\unregisterpointerinputtarget.htm
WinAuto
75faea24-91cd-448b-b67a-09fe530f1800
12/05/2018
UnregisterPointerInputTarget, UnregisterPointerInputTarget function [Windows Accessibility], inputmsg.getactivepointers, winauto.unregisterpointerinputtarget, winuser/UnregisterPointerInputTarget
winuser.h
Windows.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
User32.lib
User32.dll
Windows
19H1
UnregisterPointerInputTarget
winuser/UnregisterPointerInputTarget
c++
APIRef
kbSyntax
DllExport
User32.dll
API-MS-Win-RTCore-NTUser-WMPointer-l1-1-1.dll
MinUser.dll
API-Ms-Win-RTCore-NTUser-WMPointer-L1-1-2.dll
API-MS-Win-RTCore-NTUser-WMPointer-L1-1-3.dll
UnregisterPointerInputTarget

UnregisterPointerInputTarget function

-description

Allows the caller to unregister a target window to which all pointer input of the specified type is redirected.

-parameters

-param hwnd [in]

Window to be un-registered as a global redirection target on its desktop.

-param pointerType [in]

Type of pointer input to no longer be redirected to the specified window. This is any valid and supported value from the POINTER_INPUT_TYPE enumeration. Note that the generic PT_POINTER type and the PT_MOUSE type are not valid in this parameter.

-returns

If the function succeeds, the return value is non-zero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

-remarks

An application that has successfully called the RegisterPointerInputTarget function can call this function to un-register the window from the role of global redirected target for the specified pointer type.

An application that has registered the same window as a global redirection target for multiple pointer input types can call the UnregisterPointerInputTarget to un-register the window for one of those types while leaving the window registered for the remaining types.

If the calling thread does not have the UI Access privilege, this function fails with the last error set to ERROR_ACCESS_DENIED.

If the specified pointer input type is not valid, this function fails with the last error set to ERROR_INVALID_PARAMETER.

If the calling thread does not own the specified window, this function fails with the last error set to ERROR_ACCESS_DENIED.

If the specified window is not the registered global redirection target for the specified pointer input type on its desktop, this function takes no action and returns success.