Jump to content

WinQueryTaskTitle: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
mNo edit summary
Line 4: Line 4:
  WinQueryTaskTitle(sessionId, titleReceived, titleLngth)
  WinQueryTaskTitle(sessionId, titleReceived, titleLngth)


=== Parameters ===
== Parameters ==
; sessionId - [[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 - [[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 - ULONG - input : Maximum length of title, in bytes.
; titleLength - ULONG - input : Maximum length of title, in bytes.


=== Constants ===
== Constants ==
None
None


=== Returns ===
== Returns ==
[[APIRET]] with values of:
[[APIRET]] with values of:
;Zero : Success
;Zero : Success
Line 21: Line 21:
*[[PM Error Codes#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
INCL_WINSWITCHLIST or INCL_PM or INCL_WIN


=== Calling Convention ===
== Calling Convention ==
[[Cdecl32]]
[[Cdecl32]]


=== Example Code ===
== Example Code ==
  ULONG  sessionId;
  ULONG  sessionId;
  PSZ    titleReceived;
  PSZ    titleReceived;
Line 36: Line 36:
  ...
  ...


=== Related Functions ===
== Related Functions ==
*[[WinAddSwitchEntry]]
*[[WinAddSwitchEntry]]
*[[WinChangeSwitchEntry]]
*[[WinChangeSwitchEntry]]
Line 48: Line 48:
*[[WinSwitchToProgram]]
*[[WinSwitchToProgram]]


=== Notes ===
== Notes ==
[[WinQuerySessionTitle]] is the preferred API call.
[[WinQuerySessionTitle]] is the preferred API call.


[[Category:Win]]
[[Category:Win]]

Revision as of 05:27, 20 May 2018

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.