WinSetPointerPos: Difference between revisions

Latest revision as of 19:07, 14 May 2025

WinSetPointerPos sets the pointer position.

Syntax

WinSetPointerPos(desktopHndl, x, y)

Parameters

desktopHndl (HWND) - input: The desktop handle whether HWND_DESKTOP or another valid value.
x (LONG) - input: x-coordinate in pixels relative to the desktop's lower left corner in screen units.
y (LONG) - input: y-coordinate in pixels relative to the desktop's lower left corner in screen units.

Returns

Returns (BOOL):

TRUE Successful
FALSE Unsuccessful

WinGetLastError could return:

PMERR_INVALID_HWND

Define (C/C++)

INCL_WINPOINTERS or INCL_PM or INCL_WIN

Calling Convention

Cdecl32

Example Code

HWND desktopHndl;
LONG x;
LONG y;
BOOL rc;
...
rc = WinSetPointerPos(desktopHndl, x, y);

Related Functions

WinCreatePointer
WinCreatePointerIndirect
WinDestroyPointer
WinDrawPointer
WinLoadPointer
WinQueryPointer
WinQueryPointerInfo
WinQueryPointerPos
WinQuerySysPointer
WinQuerySysPointerData
WinSetSysPointerData
WinShowPointer

@@ Line 1: / Line 1: @@
-== WinStartTimer ==
+WinSetPointerPos sets the pointer position.
-; WinSetPointerPos(desktopHndl, x, y) : Set the pointer position.
-=== Parameters ===
+==Syntax==
-; desktopHndl - [[OS2_API:DataType:HWND|HWND]] - input : The desktop handle whether [[OS2 API:Constant:HWND_DESKTOP|HWND_DESKTOP]] or another valid value.
+ WinSetPointerPos(desktopHndl, x, y)
-; x - [[OS2_API:DataType:LONG|LONG]] - input : x-coordinate in pixels relative to the desktop's lower left corner in screen units.
-; y - [[OS2 API:DataType:LONG|LONG]] - input : y-coordinate in pixels relative to the desktop's lower left corner in screen units.
-=== Constants ===
+==Parameters==
+;desktopHndl ([[HWND]]) - input : The desktop handle whether [[HWND_DESKTOP]] or another valid value.
+;x ([[LONG]]) - input : x-coordinate in pixels relative to the desktop's lower left corner in screen units.
+;y (LONG) - input : y-coordinate in pixels relative to the desktop's lower left corner in screen units.
-=== Returns ===
+==Returns==
-Returns [[OS2_API:DataType:BOOL|BOOL]]:
+Returns (BOOL):
-* [[OS2 API:Constant:TRUE|TRUE]] Successful
+*[[TRUE]] Successful
-* [[OS2 API:Constant:FALSE|FALSE]] Unsuccessful
+*[[FALSE]] Unsuccessful
-[[OS2 API:WinGetLastError|WinGetLastError]] could return:
+[[WinGetLastError]] could return:
-* [[OS2 API:PMI:error#PMERR_INVALID_HWND|PMERR_INVALID_HWND]]
+* [[PM Error Codes#PMERR_INVALID_HWND|PMERR_INVALID_HWND]]
-=== Module ===
 === Define (C/C++) ===
 INCL_WINPOINTERS or INCL_PM or INCL_WIN
-=== Export name/Ordinal ===
+=== Calling Convention ===
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+==Example Code==
-  [[OS2 API:DataType:HWND|HWND]] desktopHndl;
+  HWND desktopHndl;
-  [[OS2 API:DataType:LONG|LONG]] x;
+  LONG x;
-  [[OS2 API:DataType:LONG|LONG]] y;
+  LONG y;
-  [[OS2 API:DataType:BOOL|BOOL]] rc;
+  BOOL rc;
   ...
   rc = WinSetPointerPos(desktopHndl, x, y);
- ...
-=== Related Functions ===
-[[OS2 API:WinCreatePointer|WinCreatePointer]] [[OS2_API:WinCreatePointerIndirect|WinCreatePointerIndirect]] [[OS2_API:WinDestroyPointer|WinDestroyPointer]]
-[[OS2_API:WinDrawPointer|WinDrawPointer]]
-[[OS2_API:WinLoadPointer|WinLoadPointer]]
-[[OS2_API:WinQueryPointer|WinQueryPointer]]
-[[OS2_API:WinQueryPointerInfo|WinQueryPointerInfo]]
-[[OS2_API:WinQueryPointerPos|WinQueryPointerPos]]
-[[OS2_API:WinQuerySysPointer|WinQuerySysPointer]]
-[[OS2_API:WinQuerySysPointerData|WinQuerySysPointerData]]
-[[OS2_API:WinSetPointer|WinSetPointer]]
-[[OS2_API:WinSetSysPointerData|WinSetSysPointerData]]
-[[OS2_API:WinShowPointer|WinShowPointer]]
-=== Notes ===
-=== OS Version Introduced ===
+==Related Functions==
+*WinCreatePointer
+*WinCreatePointerIndirect
+*WinDestroyPointer
+*WinDrawPointer
+*WinLoadPointer
+*WinQueryPointer
+*WinQueryPointerInfo
+*WinQueryPointerPos
+*WinQuerySysPointer
+*WinQuerySysPointerData
+*WinSetSysPointerData
+*[[WinShowPointer]]
-[[Category:The OS/2 API Project]]
+[[Category:Win]]