Jump to content

WinQueryTaskTitle: Difference between revisions

From EDM2
m formatting tweaking
m formatting and function description
Line 1: Line 1:
== WinQueryTaskTitle ==
== WinQueryTaskTitle ==
; WinQueryTaskTitle(sessionId, titleReceived, titleLngth) :
; WinQueryTaskTitle(sessionId, titleReceived, titleLngth) : Get the task list entry.




=== Parameters ===
=== Parameters ===
; sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input :
; sessionId - [[OS2 API:DataType:ULONG|ULONG]] - input : The session identifier or zero for the caller's session.
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 - [[OS2 API:DataType:PSZ|PSZ]]- output :
; titleLength - [[OS2 API:DataType:ULONG|ULONG]] - input : Maximum length of title, in bytes.
Title of the application as specified with the session identifier.
; titleLength - [[OS2 API:DataType:ULONG|ULONG]] - input :
Maximum length of title, in bytes.


=== Constants ===
=== Constants ===

Revision as of 04:29, 1 May 2006

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:

Module

Define (C/C++)

INCL_WINSWITCHLIST or INCL_PM or INCL_WIN

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

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

Related Functions

WinAddSwitchEntry WinChangeSwitchEntry WinCreateSwitchEntry WinQuerySessionTitle WinQuerySwitchEntry WinQuerySwitchHandle WinQuerySwitchList WinTaskSizePos WinRemoveSwitchEntry WinSwitchToProgram

Notes

WinQuerySessionTitle is the preferred API call.

OS Version Introduced