WinQuerySessionTitle: Difference between revisions

← Older edit Newer edit →

Revision as of 03:13, 14 January 2017

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.

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 conversion

Cdecl32

Example Code

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

Related Functions

@@ Line 3: / Line 3: @@
 === Parameters ===
-; anchorBlockHndl - [[OS2 API:DataType:HAB|HAB]] - input :  The anchor block handle.
+;anchorBlockHndl - [[HAB]] - input :  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 - [[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.
+;titleStr - [[PSZ]] - output :  Task list title to be returned.
-;titleStrLen - [[OS2 API:DataType:ULONG|ULONG]] - input : Maximum length of the title to be returned.
+;titleStrLen - ULONG - input : Maximum length of the title to be returned.
-=== Constants ===
-None
 === 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]]
 * [[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
-=== Module ===
 === Define (C/C++) ===
 INCL_WINSWITCHLIST or INCL_WIN or INCL_PM
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 30: / Line 23: @@
 === 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;
-  [[OS2 API:DataType:ULONG|ULONG]] rc;
+  ULONG rc;
   ...
   rc = WinQuerySessionTitle(anchorBlockHndl, sessionId, titleStr, titleStrLen);
@@ Line 40: / Line 33: @@
 === 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:The OS/2 API Project]]
+[[Category:Win]]