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

# XtfGetOverlayFolder

> XtfGetOverlayFolder

# XtfGetOverlayFolder

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

## Syntax

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

### Parameters

*address*\
型: PCWSTR

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

*packageFullName*\
型: PCWSTR

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

*overlayFolderPath*\
型: PWSTR

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

*overlayFolderPathLength*\
型: UINT32

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

### Return value

型: HRESULT

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

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

## Remarks

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

## Requirements

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

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

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

## See also

[XTF Transport Errors (NDA topic)](https://docs.xbox.com/ja-jp/tools/tools-console/commandlinetools/xtf-transport-errors.md)\
[Additional Xtf APIs](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/atoc-xtfapi.md)\
[Debugging with Overlay Folders (NDA topic)](https://docs.xbox.com/ja-jp/build/console-features/debugging-diagnostics/debugging-with-overlay-folders.md)\
コマンド ライン ツール [xbapp overlayfolder (NDA topic)](https://docs.xbox.com/ja-jp/tools/tools-console/commandlinetools/xbapp.md)


## Related topics

- [XtfSetOverlayFolder](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/functions/xtfsetoverlayfolder-xtfapi-xbox-windows-m.md)
- [XtfClearAllOverlayFolders](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/functions/xtfclearalloverlayfolders-xtfapi-xbox-windows-m.md)
- [その他の Xtf API (API の内容)](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
- [PFGameSaveFilesGetFolder](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgamesavefiles/functions/pfgamesavefilesgetfolder.md)
- [XGameSaveFilesGetFolderWithUiAsync](https://docs.xbox.com/ja-jp/reference/system/xgamesavefiles/functions/xgamesavefilesgetfolderwithuiasync.md)