WinQueryTaskTitle: Difference between revisions

← Older edit Newer edit →

Revision as of 03:09, 14 January 2017

WinQueryTaskTitle

WinQueryTaskTitle(sessionId, titleReceived, titleLngth): Get the task list entry.

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 conversion

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 3: / Line 3: @@
 === Parameters ===
-; sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input : The session identifier or zero for the caller's session.
+; sessionId - [[ULONG]] - input : The session identifier or zero for the caller's session.
-; titleReceived - [[OS2 API:DataType:PSZ|PSZ]]- output : Title of the application as specified with the session identifier.
+; titleReceived - [[PSZ]]- output : Title of the application as specified with the session identifier.
-; titleLength - [[OS2 API:DataType:ULONG|ULONG]] - input : Maximum length of title, in bytes.
+; titleLength - ULONG - input : Maximum length of title, in bytes.
 === Constants ===
@@ Line 11: / Line 11: @@
 === Returns ===
-[[OS2 API:DataType:APIRET|APIRET]] with values of:
+[[APIRET]] with values of:
 ;Zero : Success
 ;Nonzero : Error.
-[[OS2 API:WinGetLastError|WinGetLastError]] possible returns:
+[[WinGetLastError]] possible returns:
-* [[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
+*[[OS2 API:PMI:error#PMERR_INVALID_PARAMETERS|PMERR_INVALID_PARAMETERS]]
-* [[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
+*[[OS2 API:PMI:error#PMERR_INVALID_SESSION_ID|PMERR_INVALID_SESSION_ID]]
-=== Module ===
 === Define (C/C++) ===
 INCL_WINSWITCHLIST or INCL_PM or INCL_WIN
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 30: / Line 26: @@
 === Example Code ===
-  [[OS2 API:DataType:ULONG|ULONG]]  sessionId;
+  ULONG  sessionId;
-  [[OS2 API:DataType:PSZ|PSZ]]    titleReceived;
+  PSZ    titleReceived;
-  [[OS2 API:DataType:ULONG|ULONG]]  titleLngth;
+  ULONG  titleLngth;
-  [[OS2 API:DataType:APIRET|APIRET]] rc;
+  APIRET rc;
   ...
   rc = WinQueryTaskTitle(sessionId, titleReceived, titleLngth);
@@ Line 39: / Line 35: @@
 === Related Functions ===
-[[OS2 API:WinAddSwitchEntry|WinAddSwitchEntry]]
+*[[WinAddSwitchEntry]]
-[[OS2 API:WinChangeSwitchEntry|WinChangeSwitchEntry]]
+*[[WinChangeSwitchEntry]]
-[[OS2 API:WinCreateSwitchEntry|WinCreateSwitchEntry]]
+*[[WinCreateSwitchEntry]]
-[[OS2 API:WinQuerySessionTitle|WinQuerySessionTitle]]
+*[[WinQuerySessionTitle]]
-[[OS2 API:WinQuerySwitchEntry|WinQuerySwitchEntry]]
+*[[WinQuerySwitchEntry]]
-[[OS2 API:WinQuerySwitchHandle|WinQuerySwitchHandle]]
+*[[WinQuerySwitchHandle]]
-[[OS2 API:WinQuerySwitchList|WinQuerySwitchList]]
+*[[WinQuerySwitchList]]
-[[OS2 API:WinTaskSizePos|WinTaskSizePos]]
+*[[WinTaskSizePos]]
-[[OS2 API:WinRemoveSwitchEntry|WinRemoveSwitchEntry]]
+*[[WinRemoveSwitchEntry]]
-[[OS2 API:WinSwitchToProgram|WinSwitchToProgram]]
+*[[WinSwitchToProgram]]
 === Notes ===
-[[OS2 API:WinQuerySessionTitle|WinQuerySessionTitle]] is the preferred API call.
+[[WinQuerySessionTitle]] is the preferred API call.
-=== OS Version Introduced ===
-[[Category:The OS/2 API Project]]
+[[Category:Win]]