WinQuerySwitchList: Difference between revisions

← Older edit Newer edit →

Revision as of 17:59, 18 January 2017

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.

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 conversion

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 4: / Line 4: @@
 === Parameters ===
 ; anchorBlockHndl - [[HAB]] - input : The anchor block handle.
-; swblockStruct - [[SWBLOCK]] - output : Pass the [[OS2 API:DataType:SWBLOCK|SWBLOCK]] struct for population or [[NULL]] to get the number of switch entries.
+; 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.
@@ Line 12: / Line 12: @@
 ; 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]]
 * [[OS2 API:PMI:error#PMERR_NO_SPACE|PMERR_NO_SPACE]]
@@ Line 38: / Line 38: @@
 === 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.
+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:Win]]