IXtfApplicationClient::QueryExecutionState

Article
06/22/2023

Queries the execution state of the app with the specified package moniker.

Syntax

public:
HRESULT QueryExecutionState(
         LPCWSTR pszPackageMoniker,
         DWORD *dwState
)

Parameters

pszPackageMoniker
Type: LPCWSTR

A pointer to the package moniker of the app to query.

dwState
Type: DWORD*

A pointer that receives the execution state of the app. This parameter is set to one of the values listed in the following table.

Constant	Value	Description
Unknown	0	The execution state of the app is unknown.
Running	1	The app is currently running.
Suspending	2	The app is in the process of suspending.
Suspended	3	Execution of the app is currently suspended.
Terminated	4	The app has been terminated.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an HRESULT error code.

Remarks

This method queries the execution state of the app with the specified package name. This method is similar to the xbapp query command from the Application Management (xbapp.exe) tool, included as part of the Xbox Tools Framework (XTF). For more information about the xbapp query command, see Application Management (xbapp.exe) (NDA topic)Authorization required.

For more information about game life cycle states, see Xbox Game Life Cycle (NDA topic)Authorization required.

Requirements

Header: xtfapplication.h

Library: xtfapplication.lib

Supported platforms: Windows (for Xbox console tools)

Share via