Share via

XtfClearAllOverlayFolders

  • Article

Clears the Overlay Folder paths for all packages installed/registered on the console.

Syntax

HRESULT XtfClearAllOverlayFolders(
        PCWSTR address
)

Parameters

address
Type: PCWSTR

[in] Pointer to the address of the console.

Return value

Type: HRESULT

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

Remarks

Resets the current overlay folder for all PFNs on the devkit. This creates the appearance that no overlay folder has ever been set for any of the PFNs.

Calling XtfClearAllOverlayFolders has the same effect as issuing the command line xbapp overlayfolder /R (NDA topic).

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)

See also

Debugging with Overlay Folders (NDA topic)
Command line tool xbapp overlayfolder (NDA topic)
XTF Transport Errors (NDA topic) Additional Xtf APIs