XtfGetTitleOSState

Query the state of the Title OS, Fast Iteration Mode, running Title, associate PID, and Package information.

Syntax

HRESULT XtfGetTitleOSState(
        PCWSTR address,
        UINT32* titleStateFlags,
        UINT32* pid,
        PWSTR packageFullName,
        UINT32* packageFullNameLength,
        PWSTR aumid,
        UINT32* aumidLength)

Parameters

address
Type: PCWSTR

[in] Address of the console.

titleStateFlags
Type: UINT32 *

[out, optional] XTF_TITLESTATE_XXX states, NULL to omit.

pid
Type: UINT32 *

[out, optional] Process ID of the running title, if running, NULL to omit. Zero otherwise.

packageFullName
Type: PWSTR

[out, optional] Package Full Name of the running title, if XTF_TITLESTATE_TITLE_RUNNING, NULL for buffer size or omit.

packageFullNameLength
Type: UINT32 *

[out, optional] Length of packageFullName buffer in WCHAR, NULL to omit.

aumid
Type: PWSTR

[out, optional] AUMID of the running title, if XTF_TITLESTATE_TITLE_RUNNING, NULL for buffer size or omit.

aumidLength
Type: UINT32 *

[out, optional] Length of aumid buffer in WCHAR, NULL to omit.

Return value

Type: HRESULT 

A return value of S_OK indicates the function succeeded. Returns HRESULT_FROM_WIN32(ERROR_MORE_DATA) if packageFullName, or aumid buffers are too small.

Remarks

The required buffer length is returned in packageFullNameLength, or aumidLength respectively.

Requirements

Header: Declared in XtfApi.h.

Library: Use XtfApi.lib.