Jump to content

WinQuerySessionTitle: Difference between revisions

From EDM2
m formatting
No edit summary
Line 34: Line 34:
  [[OS2 API:DataType:PSZ|PSZ]]  titleStr;
  [[OS2 API:DataType:PSZ|PSZ]]  titleStr;
  [[OS2 API:DataType:ULONG|ULONG]] titleStrLen;
  [[OS2 API:DataType:ULONG|ULONG]] titleStrLen;
[[OS2_API | Back to OS/2 API]]
[[Category:The OS/2 API Project]]
  [[OS2 API:DataType:ULONG|ULONG]] rc;
  [[OS2 API:DataType:ULONG|ULONG]] rc;
  ...
  ...

Revision as of 15:22, 1 November 2011

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

Cdecl32

Example Code

HAB   anchorBlockHndl;
ULONG sessionId;
PSZ   titleStr;
ULONG titleStrLen;



Back to OS/2 API

ULONG rc;
...
rc = WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen);
...

Related Functions

WinAddSwitchEntry WinChangeSwitchEntry WinCreateSwitchEntry WinQuerySwitchEntry WinQuerySwitchHandle WinQuerySwitchList WinQueryTaskTitle WinRemoveSwitchEntry WinSwitchToProgram

Notes

OS Version Introduced