Jump to content

WinChangeSwitchEntry: Difference between revisions

From EDM2
WinChangeSwitchEntry created
 
m formatting
Line 1: Line 1:
== WinChangeSwitchEntry ==
== WinChangeSwitchEntry ==
; WinChangeSwitchEntry(switchHndl, switchControlStruct) :
; WinChangeSwitchEntry(switchHndl, switchControlStruct) : Modifies the specified entry in the task list.
Modifies the specified entry in the task list.


=== Parameters ===
=== Parameters ===
; switchHndl - [[OS2 API:DataType:HSWITCH|HSWITCH]] - input :
; switchHndl - [[OS2 API:DataType:HSWITCH|HSWITCH]] - input : The task list switch handle.
The task list switch handle.
; switchControlStruct - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - input : Switch control data.
; switchControlStruct - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - input :
Switch control data.


=== Constants ===
=== Constants ===

Revision as of 04:39, 1 May 2006

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:

Module

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Export name/Ordinal

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