WinQuerySessionTitle: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 6: | Line 6: | ||
== Parameters == | == Parameters == | ||
;anchorBlockHndl - [[HAB]] - input : The anchor block handle. | ;anchorBlockHndl - [[HAB]] - input : The anchor block handle. | ||
;sessionId - [[ULONG]] - input : Session identity of the application whose title is requested or zero for the caller's session. | ;sessionId - [[ULONG]] - input : Session identity of the application whose title is requested, or zero for the caller's session. | ||
;titleStr - [[PSZ]] - output : Task list title to be returned. | ;titleStr - [[PSZ]] - output : Task list title to be returned. | ||
;titleStrLen - ULONG - input : Maximum length of the title to be returned. | ;titleStrLen - ULONG - input : Maximum length of the title to be returned. | ||
== Returns == | == Returns == | ||
ULONG with values of: | |||
:Zero: Success | |||
:Non-zero: Unsuccessful | |||
[[WinGetLastError]] could return: | [[WinGetLastError]] could return: | ||
* [[ | * [[PM Error Codes#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]] | ||
* [[ | * [[PM Error Codes#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]] | ||
== Define (C/C++) == | == Define (C/C++) == | ||
Latest revision as of 16:46, 26 October 2025
Get the task list entry title.
Syntax
WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen)
Parameters
- anchorBlockHndl - HAB - input
- The anchor block handle.
- sessionId - ULONG - input
- Session identity of the application whose title is requested, or zero for the caller's session.
- titleStr - PSZ - output
- Task list title to be returned.
- titleStrLen - ULONG - input
- Maximum length of the title to be returned.
Returns
ULONG with values of:
- Zero: Success
- Non-zero: Unsuccessful
WinGetLastError could return:
Define (C/C++)
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
Calling Convention
Example Code
HAB anchorBlockHndl; ULONG sessionId; PSZ titleStr; ULONG titleStrLen; ULONG rc; ... rc = WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen); ...