WinQueryTaskTitle

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:

• PMERR_INVALID_PARAMETERS
• PMERR_INVALID_SESSION_ID

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

WinAddSwitchEntry WinChangeSwitchEntry WinCreateSwitchEntry WinQuerySessionTitle WinQuerySwitchEntry WinQuerySwitchHandle WinQuerySwitchList WinTaskSizePos WinRemoveSwitchEntry WinSwitchToProgram

Notes

WinQuerySessionTitle is the preferred API call.

OS Version Introduced

Back to OS/2 API