WinQuerySwitchList: Difference between revisions

Latest revision as of 02:19, 1 December 2019

Get the information about the entries in the task list.

Syntax

WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize)

Parameters

anchorBlockHndl - HAB - input: The anchor block handle.
swblockStruct - SWBLOCK - output: Pass the SWBLOCK struct for population or NULL to get the number of switch entries.
swblockStructSize - ULONG - input: Size of swblockStruct, in bytes. This is not a count of entries in swblockStruct.

Returns

ULONG with values of:

Zero: Error occurred.
Non-zero: Number of switch list entries in the system.

Possible errors receivable from WinGetLastError:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_PM or INCL_WIN

Calling Convention

Cdecl32

Example Code

HAB     anchorBlockHndl;
SWBLOCK swblockStruct;
ULONG   swblockStructSize;
ULONG   rc;
...
rc = WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize);
...

Related Functions

Notes

Invisible entries in the task list can have their information returned (via the SWCTL.uchVisibility flag in WinAddSwitchEntry). Using this feature, information will be retrieved that the user does not see in the task list.

@@ Line 1: / Line 1: @@
-== WinQuerySwitchList ==
+Get the information about the entries in the task list.
-; WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize) : Get the information about the entries in the task list.
-=== Parameters ===
+==Syntax==
-; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input : The anchor block handle.
+ WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize)
-; swblockStruct - [[OS2 API:DataType:SWBLOCK|SWBLOCK]] - output : Pass the [[OS2 API:DataType:SWBLOCK|SWBLOCK]] struct for population or [[OS2_API:Constant:NULL|NULL]] to get the number of switch entries.
-; swblockStructSize - [[OS2 API:DataType:ULONG|ULONG]] - input : Size of swblockStruct, in bytes.  This is not a count of entries in swblockStruct.
-=== Constants ===
+== Parameters ==
-None
+; anchorBlockHndl - [[HAB]] - input : The anchor block handle.
+; swblockStruct - SWBLOCK - output : Pass the SWBLOCK struct for population or [[NULL]] to get the number of switch entries.
+; swblockStructSize - [[ULONG]] - input : Size of swblockStruct, in bytes.  This is not a count of entries in swblockStruct.
-=== Returns ===
+== Returns ==
-[[OS2 API:DataType:ULONG|ULONG]] with values of:
+[[ULONG]] with values of:
 ; Zero : Error occurred.
 ; Non-zero : Number of switch list entries in the system.
-Possible errors receivable from [[OS2 API:WinGetLastError|WinGetLastError]]:
+Possible errors receivable 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_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_PM or INCL_WIN
-=== Export name/Ordinal ===
+== Calling Convention ==
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
-  [[OS2 API:DataType:HAB|HAB]]     anchorBlockHndl;
+  HAB     anchorBlockHndl;
-  [[OS2 API:DataType:SWBLOCK|SWBLOCK]] swblockStruct;
+  SWBLOCK swblockStruct;
-  [[OS2 API:DataType:ULONG|ULONG]]   swblockStructSize;
+  ULONG   swblockStructSize;
-  [[OS2 API:DataType:ULONG|ULONG]]   rc;
+  ULONG   rc;
   ...
   rc = WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize);
   ...
-=== Related Functions ===
+== Related Functions ==
-[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
+*[[WinAddSwitchEntry]]
-[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
+*[[WinCreateSwitchEntry]]
-[[OS2 API:WinQuerySwitchHandle|WinQuerySwitchHandle]]
+*[[WinQuerySwitchHandle]]
-[[OS2 API:WinQueryTaskTitle|WinQueryTaskTitle]]
+*[[WinQueryTaskTitle]]
-=== Notes ===
-Invisible entries in the task list can have their information returned (via the [[OS2 API:DataType:SWCTL|SWCTL]].uchVisibility flag in [[OS2_API:WinAddSwitchEntry|WinAddSwitchEntry]]).  Using this feature, information will be retrieved that the user does not see in the task list.
-=== OS Version Introduced ===
-[[OS2_API | Back to OS/2 API]]
+== Notes ==
+Invisible entries in the task list can have their information returned (via the SWCTL.uchVisibility flag in [[WinAddSwitchEntry]]).  Using this feature, information will be retrieved that the user does not see in the task list.
-[[Category:The OS/2 API Project]]
+[[Category:Win]]