WinQuerySwitchList

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:

• PMERR_INVALID_PARAMETERS
• PMERR_NO_SPACE

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

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.

OS Version Introduced

Back to OS/2 API