WinShowPointer: Difference between revisions

← Older edit Newer edit →

Revision as of 04:02, 4 January 2017

WinShowPointer(desktopHndl, flagShow): Show or hide the pointer.

Parameters

desktopHndl - HWND - input: HWND_DESKTOP or any other value - the desktop handle.
flagShow - BOOL - input

TRUE - decrement the hide count.
FALSE - increment the hide count.

Returns

Returns BOOL:

TRUE Successful
FALSE Unsuccessful

WinGetLastError possible returns:

PMERR_INVALID_HWND

Define (C/C++)

INCL_WINPOINTERS or INCL_PM or INCL_WIN

Calling conversion

Cdecl32

Example Code

HWND desktopHndl;
BOOL flagShow;
BOOL rc;
...
rc = WinShowPointer(desktopHndl, flagShow);
...

Related Functions

Notes

The pointer display level dictates the display of the pointer. The hide count needs to be zero for the pointer to display. At boot, if a pointing device exists, the pointer display level is set to zero; if a pointing device isn't detected, the pointer display level is set to one. To get the value of the pointing device call the WinQuerySysValue specifying the SV_POINTERLEVEL option.

@@ Line 1: / Line 1: @@
-== WinShowPointer ==
 ; WinShowPointer(desktopHndl, flagShow) : Show or hide the pointer.
 === Parameters ===
-; desktopHndl - [[OS2_API:DataType:HWND|HWND]] - input : [[OS2_API:Constant:HWND_DESKTOP|HWND_DESKTOP]] or any other value - the desktop handle.
+;desktopHndl - [[HWND]] - input : [[HWND_DESKTOP]] or any other value - the desktop handle.
-; flagShow - [[OS2_API:DataType:BOOL|BOOL]] - input :
+;flagShow - [[BOOL]] - input :
-* [[OS2 API:Constant:TRUE|TRUE]] - decrement the hide count.
+* [[TRUE]] - decrement the hide count.
-* [[OS2 API:Constant:FALSE|FALSE]] - increment the hide count.
+* [[FALSE]] - increment the hide count.
-=== Constants ===
 === 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]] possible returns:
+[[WinGetLastError]] possible returns:
 * [[OS2 API:PMI:error#PMERR_INVALID_HWND|PMERR_INVALID_HWND]]
-=== Module ===
 === Define (C/C++) ===
 INCL_WINPOINTERS or INCL_PM or INCL_WIN
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 29: / Line 22: @@
 === Example Code ===
-  [[OS2 API:DataType:HWND|HWND]] desktopHndl;
+  HWND desktopHndl;
-  [[OS2 API:DataType:BOOL|BOOL]] flagShow;
+  BOOL flagShow;
-  [[OS2 API:DataType:BOOL|BOOL]] rc;
+  BOOL rc;
   ...
   rc = WinShowPointer(desktopHndl, flagShow);
@@ Line 37: / Line 30: @@
 === Related Functions ===
-[[OS2 API:WinCreatePointer|WinCreatePointer]] [[OS2_API:WinCreatePointerIndirect|WinCreatePointerIndirect]] [[OS2_API:WinDestroyPointer|WinDestroyPointer]]
+*WinCreatePointer
-[[OS2_API:WinDrawPointer|WinDrawPointer]]
+*[[WinCreatePointerIndirect]]
-[[OS2_API:WinLoadPointer|WinLoadPointer]]
+*[[WinDestroyPointer]]
-[[OS2_API:WinQueryPointer|WinQueryPointer]]
+*[[WinDrawPointer]]
-[[OS2_API:WinQueryPointerInfo|WinQueryPointerInfo]]
+*[[WinLoadPointer]]
-[[OS2_API:WinQueryPointerPos|WinQueryPointerPos]]
+*[[WinQueryPointer]]
-[[OS2_API:WinQuerySysPointer|WinQuerySysPointer]]
+*[[WinQueryPointerInfo]]
-[[OS2_API:WinQuerySysPointerData|WinQuerySysPointerData]]
+*[[WinQueryPointerPos]]
-[[OS2_API:WinSetPointer|WinSetPointer]]
+*[[WinQuerySysPointer]]
-[[OS2_API:WinSetPointerPos|WinSetPointerPos]]
+*[[WinQuerySysPointerData]]
-[[OS2_API:WinSetSysPointerData|WinSetSysPointerData]]
+*[[WinSetPointer]]
+*[[WinSetPointerPos]]
+*[[WinSetSysPointerData]]
 === Notes ===
-The pointer display level dictates the display of the pointer.  The hide count needs to be zero for the pointer to display.  At boot, if a pointing device exists, the pointer display level is set to zero; if a pointing device isn't detected, the pointer display level is set to one.  To get the value of the pointing device call the [[OS2_API:WinQuerySysValue|WinQuerySysValue]] specifying the [[OS2_API:Constant:SV#SV_POINTERLEVEL|SV_POINTERLEVEL]] option.
+The pointer display level dictates the display of the pointer.  The hide count needs to be zero for the pointer to display.  At boot, if a pointing device exists, the pointer display level is set to zero; if a pointing device isn't detected, the pointer display level is set to one.  To get the value of the pointing device call the [[WinQuerySysValue]] specifying the [[OS2_API:Constant:SV#SV_POINTERLEVEL|SV_POINTERLEVEL]] option.
-=== OS Version Introduced ===
-[[Category:The OS/2 API Project]]
+[[Category:Win]]