WinQuerySwitchList: Difference between revisions

Newer edit →

Revision as of 04:26, 1 May 2006

WinQuerySwitchList

WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize): Get the information about the entries in the task list.

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.

Constants

None

Returns

ULONG with values of:

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

Possible errors receivable from WinGetLastError:

Module

Define (C/C++)

INCL_WINSWITCHLIST or INCL_PM or INCL_WIN

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

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

Related Functions

WinAddSwitchEntry WinCreateSwitchEntry WinQuerySwitchHandle WinQueryTaskTitle

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 ==
-; WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize) :
+; WinQuerySwitchList(anchorBlockHndl, swblockStruct, swblockStructSize) : Get the information about the entries in the task list.
-Get the information about the entries in the task list.
 === Parameters ===
-; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input :
+; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input : The anchor block handle.
-The anchor block handle.
+; 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.
-; swblockStruct - [[OS2 API:DataType:SWBLOCK|SWBLOCK]] - output :
+; swblockStructSize - [[OS2 API:DataType:ULONG|ULONG]] - input : Size of swblockStruct, in bytes.  This is not a count of entries in swblockStruct.
-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 ===