WinRemoveSwitchEntry

WinRemoveSwitchEntry

WinRemoveSwitchEntry(winListHndl)

Removes the specified entry from the window task list.

Parameters

winListHndl - HSWITCH - input

The task list handle which can be returned from:

• WinAddSwitchEntry
• WinCreateSwitchEntry
• WinQuerySwitchList
• WinQuerySwitchEntry

Returns

Returns ULONG:

• 0 Successful.
• Anything else - failure.

Possible results from WinGetLastError:

• PMERR_INVALID_SWITCH_HANDLE

Define (C/C++)

INCL_WINSWITCHLIST or INCL_PM or INCL_WIN

Calling conversion

Cdecl32

Example Code

HSWITCH winListHndl;
ULONG     rc;
...
rc = WinRemoveSwitchEntry(winListHndl);
...

Related Functions

WinAddSwitchEntry WinCreateSwitchEntry WinQuerySwitchList WinQuerySwitchEntry WinCreateStdWindow

Notes

An application that uses the operating system effectively should add its main window to the Window List when it starts, and remove it when it from the Window List when it stops.

You cannot remove non-OS/2 program entries since the system automatically removes them when the session expires.

If you create a standard window with FCF_TASKLIST flag, you don't need to issue WinRemoveSwitchEntry to remove the text from the tasklist. When the frame window exits, it automatically removes the switch entry.