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 ==
+Get information on a task list entry.
-; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry.
-=== Parameters ===
+==Syntax==
-; switchHndl - [[OS2 API:DataType:HSWITCH|HSWITCH]] - input : The task list switch handle that was returned by [[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]], [[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]], [[OS2 API:WinQuerySwitchList|WinQuerySwitchList]], or [[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]].
+ WinQuerySwitchEntry (switchHndl, switchControl)
-; switchControl - [[OS2 API:DataType:SWCNTRL|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.
+== 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.
-=== Constants ===
+== Returns ==
-None
+[[ULONG]] with values of:
-=== Returns ===
-[[OS2 API:DataType:ULONG|ULONG]] with values of:
 ; Zero : success
 ; Non-zero : not successful
-[[OS2 API:WinGetLastError|WinGetLastError]] could return:
+[[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]]
-=== Module ===
+== Define (C/C++) ==
-=== Define (C/C++) ===
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Export name/Ordinal ===
+== Calling Convention ==
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
-  [[OS2 API:DataType:HSWITCH|HSWITCH]] switchHndl;
+  HSWITCH switchHndl;
-  [[OS2 API:DataType:SWCNTRL|SWCNTRL]] switchControl;
+  SWCNTRL switchControl;
-  [[OS2 API:DataType:ULONG|ULONG]]   rc;
+  ULONG   rc;
   ...
   rc = WinQuerySwitchEntry(switchHndle, switchControl);
   ...
-=== Related Functions ===
+== Related Functions ==
-[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
+*[[WinAddSwitchEntry]]
-[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
+*[[WinCreateSwitchEntry]]
-[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
+*[[WinQuerySwitchList]]
-[[OS2 API:WinQueryWindowProcess|WinQueryWindowProcess]]
+*[[WinQueryWindowProcess]]
-=== Notes ===
-=== OS Version Introduced ===
-[[OS2_API | Back to OS/2 API]]
-[[Category:The OS/2 API Project]]
+[[Category:Win]]