WinQueryTaskTitle: Difference between revisions
WinQueryTaskTitle created |
m formatting tweaking |
||
| Line 16: | Line 16: | ||
=== Returns === | === Returns === | ||
[[OS2 API:DataType:APIRET|APIRET]] with values of: | [[OS2 API:DataType:APIRET|APIRET]] with values of: | ||
Zero | ;Zero : Success | ||
;Nonzero : Error. | |||
[[OS2 API:WinGetLastError|WinGetLastError]] possible returns: | [[OS2 API:WinGetLastError|WinGetLastError]] possible returns: | ||
Revision as of 07:36, 4 March 2006
WinQueryTaskTitle
- WinQueryTaskTitle(sessionId, titleReceived, titleLngth)
Parameters
- sessionId - ULONG - input
The session identifier or zero for the caller's session.
- titleReceived - PSZ- output
Title of the application as specified with the session identifier.
- titleLength - ULONG - input
Maximum length of title, in bytes.
Constants
None
Returns
APIRET with values of:
- Zero
- Success
- Nonzero
- Error.
WinGetLastError possible returns:
Module
Define (C/C++)
INCL_WINSWITCHLIST or INCL_PM or INCL_WIN
Export name/Ordinal
Calling conversion
Example Code
ULONG sessionId; PSZ titleReceived; ULONG titleLngth; APIRET rc; ... rc = WinQueryTaskTitle(sessionId, titleReceived, titleLngth); ...
Related Functions
WinAddSwitchEntry WinChangeSwitchEntry WinCreateSwitchEntry WinQuerySessionTitle WinQuerySwitchEntry WinQuerySwitchHandle WinQuerySwitchList WinTaskSizePos WinRemoveSwitchEntry WinSwitchToProgram
Notes
WinQuerySessionTitle is the preferred API call.