WinQueryTaskTitle: Difference between revisions
Appearance
mNo edit summary |
|||
(One intermediate revision by the same user not shown) | |||
Line 4: | Line 4: | ||
WinQueryTaskTitle(sessionId, titleReceived, titleLngth) | WinQueryTaskTitle(sessionId, titleReceived, titleLngth) | ||
== Parameters == | |||
; sessionId - [[ULONG]] - input : The session identifier or zero for the caller's session. | ; 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. | ; titleReceived - [[PSZ]]- output : Title of the application as specified with the session identifier. | ||
; titleLength - ULONG - input : Maximum length of title, in bytes. | ; titleLength - ULONG - input : Maximum length of title, in bytes. | ||
== Constants == | |||
None | None | ||
== Returns == | |||
[[APIRET]] with values of: | [[APIRET]] with values of: | ||
;Zero : Success | ;Zero : Success | ||
Line 21: | Line 21: | ||
*[[PM Error Codes#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]] | *[[PM Error Codes#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]] | ||
== Define (C/C++) == | |||
INCL_WINSWITCHLIST or INCL_PM or INCL_WIN | INCL_WINSWITCHLIST or INCL_PM or INCL_WIN | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
ULONG sessionId; | ULONG sessionId; | ||
PSZ titleReceived; | PSZ titleReceived; | ||
Line 36: | Line 36: | ||
... | ... | ||
== Related Functions == | |||
*[[WinAddSwitchEntry]] | *[[WinAddSwitchEntry]] | ||
*[[WinChangeSwitchEntry]] | *[[WinChangeSwitchEntry]] | ||
Line 44: | Line 44: | ||
*[[WinQuerySwitchHandle]] | *[[WinQuerySwitchHandle]] | ||
*[[WinQuerySwitchList]] | *[[WinQuerySwitchList]] | ||
*[[WinRemoveSwitchEntry]] | *[[WinRemoveSwitchEntry]] | ||
*[[WinSwitchToProgram]] | *[[WinSwitchToProgram]] | ||
== Notes == | |||
[[WinQuerySessionTitle]] is the preferred API call. | [[WinQuerySessionTitle]] is the preferred API call. | ||
[[Category:Win]] | [[Category:Win]] |
Latest revision as of 19:04, 14 May 2025
Get the task list entry.
Syntax
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:
Define (C/C++)
INCL_WINSWITCHLIST or INCL_PM or INCL_WIN
Calling Convention
Example Code
ULONG sessionId; PSZ titleReceived; ULONG titleLngth; APIRET rc; ... rc = WinQueryTaskTitle(sessionId, titleReceived, titleLngth); ...
Related Functions
- WinAddSwitchEntry
- WinChangeSwitchEntry
- WinCreateSwitchEntry
- WinQuerySessionTitle
- WinQuerySwitchEntry
- WinQuerySwitchHandle
- WinQuerySwitchList
- WinRemoveSwitchEntry
- WinSwitchToProgram
Notes
WinQuerySessionTitle is the preferred API call.