WinQuerySessionTitle: Difference between revisions
Appearance
WinQuerySessionTitle created |
m formatting |
||
Line 1: | Line 1: | ||
== WinQuerySessionTitle == | == WinQuerySessionTitle == | ||
; WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen) : | ; WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen) : Get the task list entry title. | ||
Get the task list entry title. | |||
=== Parameters === | === Parameters === | ||
; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input : | ; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input : The anchor block handle. | ||
The anchor block handle. | ;sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input : Session identity of the application whose title is requested or zero for the caller's session. | ||
;sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input : | ;titleStr - [[OS2 API:DataType:PSZ|PSZ]] - output : Task list title to be returned. | ||
Session identity of the application whose title is requested or zero for the caller's session. | ;titleStrLen - [[OS2 API:DataType:ULONG|ULONG]] - input : Maximum length of the title to be returned. | ||
;titleStr - [[OS2 API:DataType:PSZ|PSZ]] - output : | |||
Task list title to be returned. | |||
;titleStrLen - [[OS2 API:DataType:ULONG|ULONG]] - input : | |||
=== Constants === | === Constants === |
Revision as of 04:38, 1 May 2006
WinQuerySessionTitle
- WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen)
- Get the task list entry title.
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.
Constants
None
Returns
ULONG with values of:
- Zero
- Success
- Non-zero
- Unsuccessful
WinGetLastError could return:
Module
Define (C/C++)
INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
Export name/Ordinal
Calling conversion
Example Code
HAB anchorBlockHndl; ULONG sessionId; PSZ titleStr; ULONG titleStrLen; ULONG rc; ... rc = WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen); ...
Related Functions
WinAddSwitchEntry WinChangeSwitchEntry WinCreateSwitchEntry WinQuerySwitchEntry WinQuerySwitchHandle WinQuerySwitchList WinQueryTaskTitle WinRemoveSwitchEntry WinSwitchToProgram