Jump to content

WinChangeSwitchEntry: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
;WinChangeSwitchEntry(switchHndl, switchControlStruct) : Modifies the specified entry in the task list.
Modifies the specified entry in the task list.
WinChangeSwitchEntry(switchHndl, switchControlStruct)


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


=== Returns ===
=== Returns ===
Line 38: Line 38:
*[[WinQuerySwitchEntry]]
*[[WinQuerySwitchEntry]]
*[[WinQuerySwitchList]]
*[[WinQuerySwitchList]]
*[[WinQueryWindowProcess]]
*WinQueryWindowProcess


=== Notes ===
=== Notes ===
If the standard window was created with [[OS2 API:Constant:FCF#FCF_TASKLIST|FCF_TASKLIST]] it is not necessary to call WinChangeSwitchEntry; [[WinSetWindowText]], on its handle, changes the title bar and task list text.
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.
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.


[[Category:Win]]
[[Category:Win]]

Revision as of 13:42, 19 January 2017

Modifies the specified entry in the task list.

WinChangeSwitchEntry(switchHndl, switchControlStruct)

Parameters

switchHndl - HSWITCH - input
The task list switch handle.
switchControlStruct - SWCNTRL - input
Switch control data.

Returns

ULONG with values of:

Zero
success
Non-zero
unsuccessful

WinGetLastError could return:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling Convention

Cdecl32

Example Code

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

Related Functions

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.