WinCreateSwitchEntry

WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct)

Add the entry into the task list.

Parameters

anchorBlockHndl - HAB - input

The anchor block handle.

switchControlStruct - SWCNTRL - input

The switch control structure contains information about the newly created task list entry.

Returns

HSWITCH with values of:

The switch handle

succuss

NULLHANDLE

unsuccessful

WinGetLastError could return:

• PMERR_INVALID_PARAMETERS
• PMERR_INVALID_PROCESS_ID
• PMERR_INVALID_PROGRAM_TYPE
• PMERR_INVALID_SESSION_ID
• PMERR_INVALID_SWITCH_HANDLE
• PMERR_INVALID_WINDOW
• PMERR_NO_SPACE

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling Convention

Cdecl32

Example Code

HAB     anchorBlockHndl;
SWCNTRL switchControlStruct;
HSWITCH rc;
...
rc = WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct);
...

Related Functions

• WinAddSwitchEntry
• WinQuerySwitchEntry
• WinQuerySwitchList
• WinQueryWindowProcess
• WinRemoveSwitchEntry
• WinSwitchToProgram

Notes

Typically, programs add their main window's title to the task list but not the secondary windows. Programs normally specify a frame window handle as the SWCNTRL.hwnd argument.

Should you create a standard window with the FCF_TASKLIST flag you don't need to call WinAddSwitchEntry to add the text to the task list. WinCreateStdWindow updates the title bar text along with the task list text. The frame will retain the FCF_TASKLIST flag through the style FS_TASKLIST with your call WinSetWindowText on the frame window handle, which changes both the standard window title bar text and the task list text.