XtfGetOverlayFolder

Article
06/22/2023

Gets the overlay folder path associated with a specific package full name.

Syntax

HRESULT XtfGetOverlayFolder(
        PCWSTR address,
        PCWSTR packageFullName,
        PWSTR overlayFolderPath,
        UINT32* overlayFolderPathLength
)

Parameters

address
Type: PCWSTR

[in] Pointer to the address of the console.

packageFullName
Type: PCWSTR

[in] Pointer to the package full name of the app.

overlayFolderPath
Type: PWSTR

[out, optional] The overlay folder path.

overlayFolderPathLength
Type: UINT32

[in, out] Length of overlayFolderPath in WCHAR.

Return value

Type: HRESULT

If no path has been set for the specified package full name, then the returned value of overlayFolderPath is null, overlayFolderPathLength is zero (0), and S_OK is returned.

Returns S_OK if successful. Returns HRESULT_FROM_WIN32(ERROR_MORE_DATA) if overlayFolderPath is not large enough and the required buffer length will be returned in overlayFolderPathLength.

Remarks

Use XTFSetOverlayFolder to set or clear an overlay folder. Use XtfGetOverlayFolder to retrieve the overlay folder path currently set for a package. Use XtfClearAllOverlayFolders to clear all overlay folder that were previously set on the console. Use IXtfApplicationClient::GetInstalled to enumerate all packages currently installed on the console.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via