Jump to content

WinQuerySwitchEntry: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
== WinQuerySwitchEntry ==
; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry.
; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry.


=== Parameters ===
=== Parameters ===
; switchHndl - [[OS2 API:DataType:HSWITCH|HSWITCH]] - input : The task list switch handle that was returned by [[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]], [[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]], [[OS2 API:WinQuerySwitchList|WinQuerySwitchList]], or [[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]].
;switchHndl - [[HSWITCH]] - input : The task list switch handle that was returned by [[WinAddSwitchEntry]], [[WinCreateSwitchEntry]], [[WinQuerySwitchList]], or [[WinQuerySwitchEntry]].


; switchControl - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - output : The switch control data. Information about the task list entry. Using the field for the program handle, it can be used to invoke the task.
;switchControl - [[SWCNTRL]] - output : The switch control data. Information about the task list entry. Using the field for the program handle, it can be used to invoke the task.
 
=== Constants ===
None


=== Returns ===
=== Returns ===
[[OS2 API:DataType:ULONG|ULONG]] with values of:
[[ULONG]] with values of:
; Zero : success
; Zero : success
; Non-zero : not successful
; Non-zero : not successful


[[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 23: Line 19:
* [[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 35: Line 27:


=== Example Code ===
=== Example Code ===
  [[OS2 API:DataType:HSWITCH|HSWITCH]] switchHndl;
  HSWITCH switchHndl;
  [[OS2 API:DataType:SWCNTRL|SWCNTRL]] switchControl;
  SWCNTRL switchControl;
  [[OS2 API:DataType:ULONG|ULONG]]   rc;
  ULONG  rc;
  ...
  ...
  rc = WinQuerySwitchEntry(switchHndle, switchControl);
  rc = WinQuerySwitchEntry(switchHndle, switchControl);
Line 43: Line 35:


=== Related Functions ===
=== Related Functions ===
[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
*[[WinAddSwitchEntry]]
[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
*[[WinCreateSwitchEntry]]
[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
*[[WinQuerySwitchList]]
[[OS2 API:WinQueryWindowProcess|WinQueryWindowProcess]]
*[[WinQueryWindowProcess]]
 
=== Notes ===
 
=== OS Version Introduced ===
 
 
 
[[OS2_API | Back to OS/2 API]]
 


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

Revision as of 19:40, 22 December 2016

WinQuerySwitchEntry(switchHndl, switchControl)
Get information on a task list entry.

Parameters

switchHndl - HSWITCH - input
The task list switch handle that was returned by WinAddSwitchEntry, WinCreateSwitchEntry, WinQuerySwitchList, or WinQuerySwitchEntry.
switchControl - SWCNTRL - output
The switch control data. Information about the task list entry. Using the field for the program handle, it can be used to invoke the task.

Returns

ULONG with values of:

Zero
success
Non-zero
not successful

WinGetLastError could return:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_WIN or INCL_PM

Calling conversion

Cdecl32

Example Code

HSWITCH switchHndl;
SWCNTRL switchControl;
ULONG   rc;
...
rc = WinQuerySwitchEntry(switchHndle, switchControl);
...

Related Functions