WinQuerySwitchEntry: Difference between revisions

Latest revision as of 21:57, 6 August 2023

Get information on a task list entry.

Syntax

WinQuerySwitchEntry (switchHndl, switchControl)

Parameters

switchHndl - HSWITCH - input: The task list switch handle that was returned by WinAddSwitchEntry, WinCreateSwitchEntry, WinQuerySwitchList, or WinQuerySwitchEntry.
switchControl - SWCNTRL - output: The switch control data. Information about the task list entry. Using the field for the program handle, it can be used to invoke the task.

Returns

ULONG with values of:

Zero: success
Non-zero: not successful

WinGetLastError could return:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling Convention

Cdecl32

Example Code

HSWITCH switchHndl;
SWCNTRL switchControl;
ULONG   rc;
...
rc = WinQuerySwitchEntry(switchHndle, switchControl);
...

Related Functions

@@ Line 1: / Line 1: @@
-; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry.
+Get information on a task list entry.
-=== Parameters ===
+==Syntax==
-;switchHndl - [[HSWITCH]] - input : The task list switch handle that was returned by [[WinAddSwitchEntry]], [[WinCreateSwitchEntry]], [[WinQuerySwitchList]], or [[WinQuerySwitchEntry]].
+ WinQuerySwitchEntry (switchHndl, switchControl)
+== Parameters ==
+;switchHndl - [[HSWITCH]] - input : The task list switch handle that was returned by [[WinAddSwitchEntry]], [[WinCreateSwitchEntry]], [[WinQuerySwitchList]], or WinQuerySwitchEntry.
 ;switchControl - [[SWCNTRL]] - output : The switch control data. Information about the task list entry. Using the field for the program handle, it can be used to invoke the task.
-=== Returns ===
+== Returns ==
 [[ULONG]] with values of:
 ; Zero : success
@@ Line 12: / Line 14: @@
 [[WinGetLastError]] could return:
-* [[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_PROGRAM_TYPE|PMERR_INVALID_PROGRAM_TYPE]]
+* [[PM Error Codes#PMERR_INVALID_PROGRAM_TYPE|PMERR_INVALID_PROGRAM_TYPE]]
-* [[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
+* [[PM Error Codes#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
-* [[OS2 API:PMI:error#PMERR_INVALID_SWITCH_HANDLE|PMERR_INVALID_SWITCH_HANDLE]]
+* [[PM Error Codes#PMERR_INVALID_SWITCH_HANDLE|PMERR_INVALID_SWITCH_HANDLE]]
-* [[OS2 API:PMI:error#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
+* [[PM Error Codes#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
-* [[OS2 API:PMI:error#PMERR_NO_SPACE|PMERR_NO_SPACE]]
+* [[PM Error Codes#PMERR_NO_SPACE|PMERR_NO_SPACE]]
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Calling Convention ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   HSWITCH switchHndl;
   SWCNTRL switchControl;
@@ Line 34: / Line 36: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinAddSwitchEntry]]
 *[[WinCreateSwitchEntry]]