WinQuerySwitchEntry: Difference between revisions
WinQuerySwitchEntry created |
m formatting and typo correction |
||
| Line 1: | Line 1: | ||
== | == WinQuerySwitchEntry == | ||
; WinQuerySwitchEntry(switchHndl, switchControl) : | ; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry. | ||
Get information on a task list entry. | |||
=== Parameters === | === Parameters === | ||
; switchHndl - [[OS2 API:DataType:HSWITCH|HSWITCH]] - input : | ; 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]]. | ||
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]]. | |||
; switchControl - [[OS2 API:DataType:SWCNTRL|SWCNTRL]] - output : | ; 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. | ||
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 === | === Constants === | ||
Revision as of 04:14, 1 May 2006
WinQuerySwitchEntry
- 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.
Constants
None
Returns
ULONG with values of:
- Zero
- success
- Non-zero
- not successful
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
Module
Define (C/C++)
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
Export name/Ordinal
Calling conversion
Example Code
HSWITCH switchHndl; SWCNTRL switchControl; ULONG rc; ... rc = WinQuerySwitchEntry(switchHndle, switchControl); ...
Related Functions
WinAddSwitchEntry WinCreateSwitchEntry WinQuerySwitchList WinQueryWindowProcess