WinChangeSwitchEntry

WinChangeSwitchEntry

WinChangeSwitchEntry(switchHndl, switchControlStruct)

Modifies the specified entry in the task list.

Parameters

switchHndl - HSWITCH - input

The task list switch handle.

switchControlStruct - SWCNTRL - input

Switch control data.

Constants

None

Returns

ULONG with values of:

Zero

success

Non-zero

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 conversion

Cdecl32

Example Code

HSWITCH switchHndl;
SWCNTRL switchControlStruct; 
ULONG   rc;
...
rc = WinChangeSwitchEntry(switchHndl, switchControlStruct);
...

Related Functions

WinAddSwitchEntry WinCreateSwitchEntry WinQuerySwitchEntry WinQuerySwitchList WinQueryWindowProcess

Notes

If the standard window was created with FCF_TASKLIST it is not necessary to call WinChangeSwitchEntry; WinSetWindowText, on its handle, changes the title bar and task list text.

If you want to change a few fields, not many, it is advisable to initialize the switch control structure via WinQuerySwitchEntry. Then modify those fields and call WinChangeSwitchEntry for the update.

OS Version Introduced

Back to OS/2 API