Jump to content

WinCreateSwitchEntry: Difference between revisions

From EDM2
← Older editNewer edit →
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
Line 1: Line 1:
== WinCreateSwitchEntry ==
; WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct) : Add the entry into the task list.
; WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct) : Add the entry into the task list.


=== Parameters ===
=== Parameters ===
; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input : The anchor block handle.
; anchorBlockHndl - [[HAB]] - input : The anchor block handle.
; switchControlStruct - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - input : The switch control structure contains information about the newly created task list entry.
; switchControlStruct - [[SWCNTRL]] - input : The switch control structure contains information about the newly created task list entry.
 
=== Constants ===
None


=== Returns ===
=== Returns ===
[[OS2 API:DataType:HSWITCH|HSWITCH]] with values of:
[[HSWITCH]] with values of:
; The switch handle : succuss
; The switch handle : succuss
; [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]] : unsuccessful
; [[NULLHANDLE]] : unsuccessful


[[OS2 API:WinGetLastError|WinGetLastError]] could return:
[[WinGetLastError]] could return:
* [[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
* [[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
* [[OS2 API:PMI:error#PMERR_INVALID_PROCESS_ID|PMERR_INVALID_PROCESS_ID]]
* [[OS2 API:PMI:error#PMERR_INVALID_PROCESS_ID|PMERR_INVALID_PROCESS_ID]]
Line 22: Line 18:
* [[OS2 API:PMI:error#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
* [[OS2 API:PMI:error#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
* [[OS2 API:PMI:error#PMERR_NO_SPACE|PMERR_NO_SPACE]]
* [[OS2 API:PMI:error#PMERR_NO_SPACE|PMERR_NO_SPACE]]
=== Module ===


=== Define (C/C++) ===
=== Define (C/C++) ===
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
=== Export name/Ordinal ===


=== Calling conversion ===
=== Calling conversion ===
Line 34: Line 26:


=== Example Code ===
=== Example Code ===
  [[OS2 API:DataType:HAB|HAB]]     anchorBlockHndl;
  HAB    anchorBlockHndl;
  [[OS2 API:DataType:SWCNTRL|SWCNTRL]] switchControlStruct;
  SWCNTRL switchControlStruct;
  [[OS2 API:DataType:HSWITCH|HSWITCH]] rc;
  HSWITCH rc;
  ...
  ...
  rc = WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct);
  rc = WinCreateSwitchEntry(anchorBlockHndl, switchControlStruct);
Line 42: Line 34:


=== Related Functions ===
=== Related Functions ===
[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
*[[WinAddSwitchEntry]]
[[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]]
*[[WinQuerySwitchEntry]]
[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
*[[WinQuerySwitchList]]
[[OS2 API:WinQueryWindowProcess|WinQueryWindowProcess]]
*[[WinQueryWindowProcess]]
[[OS2 API:WinRemoveSwitchEntry|WinRemoveSwitchEntry]]
*[[WinRemoveSwitchEntry]]
[[OS2 API:WinSwitchToProgram|WinSwitchToProgram]]
*[[WinSwitchToProgram]]


=== Notes ===
=== 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 [[OS2_API:DatatType:SWCNTRL|SWCNTRL]].hwnd argument.
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 [[OS2 API:Constant:FCF#FCF_TASKLIST|FCF_TASKLIST]] flag you don't need to call [[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]] to add the text to the task list.  [[OS2_API:WinCreateStdWindow|WinCreateStdWindow]] updates the title bar text along with the task list text.  The frame will retain the [[OS2 API:Constant:FCF#FCF_TASKLIST|FCF_TASKLIST]] flag through the style [[OS2 API:Constant:FS#FS_TASKLIST|FS_TASKLIST]] with your call [[OS2 API:WinSetWindowText|WinSetWindowText]] on the frame window handle, which changes both the standard window title bar text and the task list text.
 
=== OS Version Introduced ===
 
 
 
[[OS2_API | Back to OS/2 API]]


Should you create a standard window with the [[FCF#FCF_TASKLIST|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#FCF_TASKLIST|FCF_TASKLIST]] flag through the style [[FS#FS_TASKLIST|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.


[[Category:The OS/2 API Project]]
[[Category:Win]]

Revision as of 19:36, 22 December 2016

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:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling conversion

Cdecl32

Example Code

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

Related Functions

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.

Retrieved from "https://www.edm2.com/index.php?title=WinCreateSwitchEntry&oldid=38596"