WinQuerySwitchHandle: Difference between revisions

Latest revision as of 21:57, 6 August 2023

Get a task list entry handle.

Syntax

WinQuerySwitchHandle (wndwHndl, processId)

Parameters

wndwHndl - HWND - input: Window handle or NULLHANDLE if specifying with processId.
processId - PID - input: Process identifier in the task list or zero if using the window handle.

Returns

Returns of HSWITCH with values of the switch handle or zero with an error occurring.

Possible returns from WinGetLastError:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling Convention

Cdecl32

Example Code

HWND    wndwHndl;
PID     processId;
HSWITCH rc;
...
rc = WinQuerySwitchHandle(wndwHndl, NULL);
...

OR

...
rc = WinQuerySwitchHandle(NULL, processId);
...

Related Functions

Notes

If wndwHndl and processId are used, they must be correct

@@ Line 1: / Line 1: @@
-;WinQuerySwitchHandle(wndwHndl, processId) : Get a task list entry handle.
+Get a task list entry handle.
-=== Parameters ===
+==Syntax==
+ WinQuerySwitchHandle (wndwHndl, processId)
+== Parameters ==
 ;wndwHndl - [[HWND]] - input : Window handle or [[NULLHANDLE]] if specifying with processId.
 ;processId - [[PID]] - input : Process identifier in the task list or zero if using the window handle.
-=== Returns ===
+== Returns ==
 Returns of [[HSWITCH]] with values of the switch handle or zero with an error occurring.
-Possible returns from [[OS2 API:WinGetLastError|WinGetLastError]]:
+Possible returns from [[WinGetLastError]]:
-* [[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
+* [[PM Error Codes#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
-* [[OS2 API:PMI:error#PMERR_INVALID_PROCESS_ID|PMERR_INVALID_PROCESS_ID]]
+* [[PM Error Codes#PMERR_INVALID_PROCESS_ID|PMERR_INVALID_PROCESS_ID]]
-* [[OS2 API:PMI:error#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
+* [[PM Error Codes#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Calling Convention ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   HWND    wndwHndl;
   PID     processId;
@@ Line 28: / Line 31: @@
 OR
   ...
-  rc = WinQuerySwitchHandle([[NULL]], processId);
+  rc = WinQuerySwitchHandle(NULL, processId);
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinQuerySwitchEntry]]
 *[[WinQueryWindowProcess]]
 *[[WinRemoveSwitchEntry]]
-=== Notes ===
+== Notes ==
 If wndwHndl and processId are used, they must be correct
 [[Category:Win]]