WinQuerySwitchEntry: Difference between revisions
Appearance
m Martini moved page OS2 API:WinQuerySwitchEntry to OS2 API:PMI:WinQuerySwitchEntry |
mNo edit summary |
||
Line 1: | Line 1: | ||
; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry. | ; WinQuerySwitchEntry(switchHndl, switchControl) : Get information on a task list entry. | ||
=== Parameters === | === Parameters === | ||
; switchHndl - [[ | ;switchHndl - [[HSWITCH]] - input : The task list switch handle that was returned by [[WinAddSwitchEntry]], [[WinCreateSwitchEntry]], [[WinQuerySwitchList]], or [[WinQuerySwitchEntry]]. | ||
; switchControl - [[ | ;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 === | === Returns === | ||
[[ | [[ULONG]] with values of: | ||
; Zero : success | ; Zero : success | ||
; Non-zero : not successful | ; Non-zero : not successful | ||
[[ | [[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]] | ||
=== Define (C/C++) === | === Define (C/C++) === | ||
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM | INCL_WINSWITCHLIST or INCL_WIN or INCL_PM | ||
=== Calling conversion === | === Calling conversion === | ||
Line 35: | Line 27: | ||
=== Example Code === | === Example Code === | ||
HSWITCH switchHndl; | |||
SWCNTRL switchControl; | |||
ULONG rc; | |||
... | ... | ||
rc = WinQuerySwitchEntry(switchHndle, switchControl); | rc = WinQuerySwitchEntry(switchHndle, switchControl); | ||
Line 43: | Line 35: | ||
=== Related Functions === | === Related Functions === | ||
[[ | *[[WinAddSwitchEntry]] | ||
[[ | *[[WinCreateSwitchEntry]] | ||
[[ | *[[WinQuerySwitchList]] | ||
[[ | *[[WinQueryWindowProcess]] | ||
[[Category: | [[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:
- 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_PM
Calling conversion
Example Code
HSWITCH switchHndl; SWCNTRL switchControl; ULONG rc; ... rc = WinQuerySwitchEntry(switchHndle, switchControl); ...