> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XtfGetOverlayFolder

> XtfGetOverlayFolder

# XtfGetOverlayFolder

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

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
HRESULT XtfGetOverlayFolder(
        PCWSTR address,
        PCWSTR packageFullName,
        PWSTR overlayFolderPath,
        UINT32* overlayFolderPathLength
)   
```

<a id="ID4ET" />

### Parameters

*address*<br />Type: PCWSTR

\[in] Pointer to the address of the console.

*packageFullName*<br />Type: PCWSTR

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

*overlayFolderPath*<br />Type: PWSTR

\[out, optional] The overlay folder path.

*overlayFolderPathLength*<br />Type: UINT32

\[in, out] Length of overlayFolderPath in WCHAR.

<a id="ID4E1" />

### 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.

<a id="remarks" />

## Remarks

Use [XTFSetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m) to set or clear an overlay folder. Use [XtfGetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m) to retrieve the overlay folder path currently set for a package. Use [XtfClearAllOverlayFolders](/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m) to clear all overlay folder that were previously set on the console. Use [IXtfApplicationClient::GetInstalled](/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/getinstalled-ixtfapplicationclient-xtfapplication-xbox-microsoft-m) 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

[XTF Transport Errors (NDA topic)](/tools/tools-console/commandlinetools/xtf-transport-errors)<br />[Additional Xtf APIs](/reference/tools/xtf/xtfapi/atoc-xtfapi)<br />[Debugging with Overlay Folders (NDA topic)](/build/console-features/debugging-diagnostics/debugging-with-overlay-folders)<br />Command line tool [xbapp overlayfolder (NDA topic)](/tools/tools-console/commandlinetools/xbapp)


## Related topics

- [XtfSetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md)
- [XtfClearAllOverlayFolders](/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md)
- [Manage overlay folders](/tools/tools-console/devhome/devhome-overlay-folders.md)
- [Managing overlay folders](/tools/tools-console/wdp/windows-device-portal-on-xbox-overlay-folders.md)
- [Home page (Dev Home)](/tools/tools-console/devhome/devhome-home.md)