WinQuerySessionTitle: Difference between revisions

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

Cdecl32

Example Code

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

Related Functions

@@ Line 1: / Line 1: @@
-== WinQuerySessionTitle ==
+Get the task list entry title.
-; WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen) : Get the task list entry title.
-=== Parameters ===
+==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.
+;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 ===
+== Returns ==
-[[ULONG]] with values of:
+ULONG with values of:
-; Zero : Success
+:Zero: Success
-; Non-zero : Unsuccessful
+:Non-zero: Unsuccessful
 [[WinGetLastError]] could return:
-* [[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
+* [[PM Error Codes#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
-* [[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
+* [[PM Error Codes#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Calling Convention ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   HAB   anchorBlockHndl;
   ULONG sessionId;
@@ Line 32: / Line 34: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinAddSwitchEntry]]
 *[[WinChangeSwitchEntry]]