Skip to main content

XtfSetOverlayFolder

Sets, or resets, the overlay folder value associated with a specific package full name.

Syntax

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: PCWSTR
[in] Pointer to a string that contains the overlay folder path. If overlayFolderPath is null then packageFullName is ignored and the Overlay Folder is reset (equivalent to xbapp overlayfolder package_full_name /r (NDA topic)).

Return value

Type: HRESULT A return value of S_OK indicates the function succeeded. Any other value indicates an unexpected error occurred.

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.
Overlay folders set using XtfSetOverlayFolder are persistent across reboots of the console.

C++ Example

Requirements

Header: xtfapi.h Library: XtfApi.lib Supported platforms: Windows (for XBOX console tools)

See also

Debugging with Overlay Folders (NDA topic)
Command line tool xbapp overlayfolder (NDA topic)
XTF Transport Errors (NDA topic)
Last modified on August 20, 2026