WinQuerySessionTitle: Difference between revisions

Latest revision as of 02:19, 1 December 2019

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==
-; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input :  The anchor block handle.
+ WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen)
-;sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input :  Session identity of the application whose title is requested or zero for the caller's session.
-;titleStr - [[OS2 API:DataType:PSZ|PSZ]] - output :  Task list title to be returned.
-;titleStrLen - [[OS2 API:DataType:ULONG|ULONG]] - input : Maximum length of the title to be returned.
-=== Constants ===
+== Parameters ==
-None
+;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 ===
+== Returns ==
-[[OS2 API:DataType:ULONG|ULONG]] with values of:
+[[ULONG]] with values of:
 ; Zero : Success
 ; Non-zero : Unsuccessful
-[[OS2 API:WinGetLastError|WinGetLastError]] could return:
+[[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]]
-=== Module ===
+== Define (C/C++) ==
-=== Define (C/C++) ===
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Export name/Ordinal ===
+== Calling Convention ==
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
-  [[OS2 API:DataType:HAB|HAB]]   anchorBlockHndl;
+  HAB   anchorBlockHndl;
-  [[OS2 API:DataType:ULONG|ULONG]] sessionId;
+  ULONG sessionId;
-  [[OS2 API:DataType:PSZ|PSZ]]   titleStr;
+  PSZ   titleStr;
-  [[OS2 API:DataType:ULONG|ULONG]] titleStrLen;
+  ULONG titleStrLen;
+  ULONG rc;
-[[OS2_API | Back to OS/2 API]]
-[[Category:The OS/2 API Project]]
-  [[OS2 API:DataType:ULONG|ULONG]] rc;
   ...
   rc = WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen);
   ...
-=== Related Functions ===
+== Related Functions ==
-[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
+*[[WinAddSwitchEntry]]
-[[OS2 API:WinChangeSwitchEntry|WinChangeSwitchEntry]]
+*[[WinChangeSwitchEntry]]
-[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
+*[[WinCreateSwitchEntry]]
-[[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]]
+*[[WinQuerySwitchEntry]]
-[[OS2 API:WinQuerySwitchHandle|WinQuerySwitchHandle]]
+*[[WinQuerySwitchHandle]]
-[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
+*[[WinQuerySwitchList]]
-[[OS2 API:WinQueryTaskTitle|WinQueryTaskTitle]]
+*[[WinQueryTaskTitle]]
-[[OS2 API:WinRemoveSwitchEntry|WinRemoveSwitchEntry]]
+*[[WinRemoveSwitchEntry]]
-[[OS2 API:WinSwitchToProgram|WinSwitchToProgram]]
+*[[WinSwitchToProgram]]
-=== Notes ===
-=== OS Version Introduced ===
+[[Category:Win]]