WinQueryTaskTitle: Difference between revisions

Latest revision as of 19:04, 14 May 2025

Get the task list entry.

Syntax

WinQueryTaskTitle(sessionId, titleReceived, titleLngth)

Parameters

sessionId - ULONG - input: The session identifier or zero for the caller's session.
titleReceived - PSZ- output: Title of the application as specified with the session identifier.
titleLength - ULONG - input: Maximum length of title, in bytes.

Constants

None

Returns

APIRET with values of:

Zero: Success
Nonzero: Error.

WinGetLastError possible returns:

Define (C/C++)

INCL_WINSWITCHLIST or INCL_PM or INCL_WIN

Calling Convention

Cdecl32

Example Code

ULONG  sessionId;
PSZ    titleReceived;
ULONG  titleLngth;
APIRET rc;
...
rc = WinQueryTaskTitle(sessionId, titleReceived, titleLngth);
...

Related Functions

Notes

WinQuerySessionTitle is the preferred API call.

@@ Line 1: / Line 1: @@
-== WinQueryTaskTitle ==
+Get the task list entry.
-; WinQueryTaskTitle(sessionId, titleReceived, titleLngth) : Get the task list entry.
-=== Parameters ===
+==Syntax==
+ WinQueryTaskTitle(sessionId, titleReceived, titleLngth)
+== Parameters ==
 ; sessionId - [[ULONG]] - input : The session identifier or zero for the caller's session.
 ; titleReceived - [[PSZ]]- output : Title of the application as specified with the session identifier.
 ; titleLength - ULONG - input : Maximum length of title, in bytes.
-=== Constants ===
+== Constants ==
 None
-=== Returns ===
+== Returns ==
 [[APIRET]] with values of:
 ;Zero : Success
@@ Line 16: / Line 18: @@
 [[WinGetLastError]] possible returns:
-*[[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_PM or INCL_WIN
-=== Calling Convention ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   ULONG  sessionId;
   PSZ    titleReceived;
@@ Line 34: / Line 36: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinAddSwitchEntry]]
 *[[WinChangeSwitchEntry]]
@@ Line 42: / Line 44: @@
 *[[WinQuerySwitchHandle]]
 *[[WinQuerySwitchList]]
-*[[WinTaskSizePos]]
 *[[WinRemoveSwitchEntry]]
 *[[WinSwitchToProgram]]
-=== Notes ===
+== Notes ==
 [[WinQuerySessionTitle]] is the preferred API call.
 [[Category:Win]]