WinAddSwitchEntry: Difference between revisions

Latest revision as of 14:38, 4 October 2023

Add an entry to the task list.

Syntax

WinAddSwitchEntry(switchControlStruct)

Parameters

switchControlStruct - SWCNTRL - input: The switch control data structure which contains information about the entry.

Returns

HSWITCH with values of:

The switch handle: success
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_LIST

Calling Convention

Cdecl32

Example Code

SWCNTRL switchControlStruct;
HSWITCH rc;
...
rc = WinAddSwitchEntry(switchControlStruct);
...

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.

Related Functions

@@ Line 1: / Line 1: @@
-== WinAddSwitchEntry ==
+Add an entry to the task list.
-; WinAddSwitchEntry(switchControlStruct) : Add an entry to the task list.
-=== Parameters ===
+==Syntax==
-; switchControlStruct - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - input : The switch control data structure which contains information about the entry.
+ WinAddSwitchEntry(switchControlStruct)
-=== Constants ===
+==Parameters==
-None
+; switchControlStruct - [[SWCNTRL]] - input : The switch control data structure which contains information about the entry.
-=== Returns ===
+== Returns ==
-[[OS2 API:DataType:HSWITCH|HSWITCH]] with values of:
+[[HSWITCH]] with values of:
-; The switch handle : succuss
+; The switch handle : success
-; [[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]]
+* PMERR_INVALID_PARAMETERS
-* [[OS2 API:PMI:error#PMERR_INVALID_PROCESS_ID|PMERR_INVALID_PROCESS_ID]]
+* PMERR_INVALID_PROCESS_ID
-* [[OS2 API:PMI:error#PMERR_INVALID_PROGRAM_TYPE|PMERR_INVALID_PROGRAM_TYPE]]
+* PMERR_INVALID_PROGRAM_TYPE
-* [[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
+* PMERR_INVALID_SESSION_ID
-* [[OS2 API:PMI:error#PMERR_INVALID_SWITCH_HANDLE|PMERR_INVALID_SWITCH_HANDLE]]
+* PMERR_INVALID_SWITCH_HANDLE
-* [[OS2 API:PMI:error#PMERR_INVALID_WINDOW|PMERR_INVALID_WINDOW]]
+* PMERR_INVALID_WINDOW
-* [[OS2 API:PMI:error#PMERR_NO_SPACE|PMERR_NO_SPACE]]
+* PMERR_NO_SPACE
-=== Module ===
+== Define (C/C++) ==
-=== Define (C/C++) ===
 INCL_WINSWITCHLIST or INCL_WIN or INCL_LIST
-=== Export name/Ordinal ===
+== Calling Convention ==
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
-  [[OS2 API:DataType:SWCNTRL|SWCNTRL]] switchControlStruct;
+  SWCNTRL switchControlStruct;
-  [[OS2 API:DataType:HSWITCH|HSWITCH]] rc;
+  HSWITCH rc;
   ...
   rc = WinAddSwitchEntry(switchControlStruct);
   ...
-=== Related Functions ===
+== Notes ==
-[[OS2 API:WinCreateStdWindow|WinCreateStdWindow]]
+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.
-[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
-[[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]]
-[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
-[[OS2 API:WinQueryWindowProcess|WinQueryWindowProcess]]
-[[OS2 API:WinRemoveSwitchEntry|WinRemoveSwitchEntry]]
-[[OS2 API:WinSwitchToProgram|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 [[OS2_API:DatatType:SWCNTRL|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_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.
+== Related Functions ==
+*[[WinCreateStdWindow]]
+*[[WinCreateSwitchEntry]]
+*[[WinQuerySwitchEntry]]
+*[[WinQuerySwitchList]]
+*[[WinQueryWindowProcess]]
+*[[WinRemoveSwitchEntry]]
+*[[WinSwitchToProgram]]
-[[Category:The OS/2 API Project]]
+[[Category:Win]]