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

特定のパッケージのフル ネームに関連付けられたオーバーレイ フォルダー パスを取得します。

<a id="syntaxSection" />

## Syntax

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

<a id="ID4ET" />

### Parameters

*address*<br />型: PCWSTR

\[in] コンソールのアドレスへのポインターです。

*packageFullName*<br />型: PCWSTR

\[in] アプリのパッケージのフル ネームへのポインターです。

*overlayFolderPath*<br />型: PWSTR

\[out, optional] オーバーレイ フォルダー パスです。

*overlayFolderPathLength*<br />型: UINT32

\[in, out] overlayFolderPath の長さ (WCHAR 単位) です。

<a id="ID4E1" />

### Return value

型: HRESULT

指定されたパッケージのフル ネームに対してパスが設定されていない場合、overlayFolderPath の戻り値は **null**、overlayFolderPathLength は 0 (ゼロ) となり、**S\_OK** が返されます。

成功した場合は **S\_OK** を返します。overlayFolderPath の長さが足りない場合は **HRESULT\_FROM\_WIN32(ERROR\_MORE\_DATA)** を返し、必要なバッファーの長さが overlayFolderPathLength に返されます。

<a id="remarks" />

## Remarks

オーバーレイ フォルダーの設定や解除には [XTFSetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m) を使用します。パッケージに現在設定されているオーバーレイ フォルダー パスを取得するには [XtfGetOverlayFolder](/reference/tools/xtf/xtfapi/functions/xtfgetoverlayfolder-xtfapi-xbox-windows-m) を使用します。コンソール上で以前に設定されたすべてのオーバーレイ フォルダーをクリアするには [XtfClearAllOverlayFolders](/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m) を使用します。コンソールに現在インストールされているすべてのパッケージを列挙するには [IXtfApplicationClient::GetInstalled](/reference/tools/xtf/xtfapplication/classes/IXtfApplicationClient/methods/getinstalled-ixtfapplicationclient-xtfapplication-xbox-microsoft-m) を使用します。

## Requirements

**ヘッダー:** xtfapi.h

**ライブラリ:** XtfApi.lib

**サポートされているプラットフォーム:** Windows (XBOX コンソール ツール用)

## 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 />コマンド ライン ツール [xbapp overlayfolder (NDA topic)](/tools/tools-console/commandlinetools/xbapp)


## Related topics

- [XtfSetOverlayFolder](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md)
- [XtfClearAllOverlayFolders](/ja-jp/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md)
- [XGameSaveFilesGetFolderWithUiAsync](/ja-jp/reference/system/xgamesavefiles/functions/xgamesavefilesgetfolderwithuiasync.md)
- [XGameSaveFilesGetFolderWithUiResult](/ja-jp/reference/system/xgamesavefiles/functions/xgamesavefilesgetfolderwithuiresult.md)
- [XBOX タイトル向けの Title Performance Overlay](/ja-jp/tools/tools-console/titleperfoverlay/index.md)