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

# XtfSetOverlayFolder

> XtfSetOverlayFolder

# XtfSetOverlayFolder

特定のパッケージ完全名に関連付けられたオーバーレイ フォルダーの値を設定またはリセットします。

## 構文

```cpp theme={null}
HRESULT XtfSetOverlayFolder(
        PCWSTR address,
        PCWSTR packageFullName,
        PCWSTR overlayFolderPath
)   
```

### パラメーター

*address*\
型: PCWSTR

\[in] 本体のアドレスへのポインターです。

*packageFullName*\
型: PCWSTR

\[in] アプリのパッケージ完全名へのポインターです。

*overlayFolderPath*\
型: PCWSTR

\[in] オーバーレイ フォルダーのパスを含む文字列へのポインターです。 overlayFolderPath が **null** の場合、packageFullName は無視され、オーバーレイ フォルダーはリセットされます ([xbapp overlayfolder package\_full\_name /r (NDA トピック)](https://docs.xbox.com/ja-jp/tools/tools-console/commandlinetools/xbapp.md) と同等)。

### 戻り値

型: HRESULT

戻り値が **S\_OK** の場合、関数は成功しています。 それ以外の値の場合は、予期しないエラーが発生したことを示します。

## 解説

オーバーレイ フォルダーを設定またはクリアするには、[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) を使用します。

> [!NOTE]
>
> XtfSetOverlayFolder を使用して設定されたオーバーレイ フォルダーは、本体の再起動後も維持されます。

## C++ の例

```cpp theme={null}
int wmain(int argc, wchar_t **argv)
{
    HRESULT             hr = S_OK;
    PCWSTR              consoleAddress = L"190.167.10.18";
    PCWSTR              pOverlayFolderPFN = L"682716bc-bcec-4d5b-a21d-e2b6a4e3066d_1.0.0.0_x64__8wekyb3d8bbwe";
    PWSTR               pOverlayFolderPath = L"D:\\MyGame1\\";
    PWSTR               pOverlayFolderPathReturned = nullptr;
    UINT32              bufferSize = 0;

    hr = XtfSetOverlayFolder(consoleAddress, pOverlayFolderPFN, pOverlayFolderPath);
    if (FAILED(hr))
    {
        wprintf(L"\n\n*** XtfSetOverlayFolder failed 0x%x", hr);
        return hr;
    }

    pOverlayFolderPathReturned = new WCHAR[APPLICATION_USER_MODEL_ID_MAX_LENGTH];
    hr = XtfGetOverlayFolder(consoleAddress, pOverlayFolderPFN, pOverlayFolderPathReturned, &buffersize);
    if (FAILED(hr))
    {
        wprintf(L"\n\n*** Overlay Folder Path is set to %s", pOverlayFolderPathReturned);
    }
    else
    {
        wprintf(L"\n\n*** XtfGetOverlayFolder failed 0x%x", hr);
    }
    delete[] pOverlayFolderPathReturned;

    return hr;
}
```

## 要件

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

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

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

## 関連項目

[オーバーレイ フォルダーを使用したデバッグ (NDA トピック)](https://docs.xbox.com/ja-jp/build/console-features/debugging-diagnostics/debugging-with-overlay-folders.md)\
コマンドライン ツール [xbapp overlayfolder (NDA トピック)](https://docs.xbox.com/ja-jp/tools/tools-console/commandlinetools/xbapp.md)\
[XTF トランスポート エラー (NDA トピック)](https://docs.xbox.com/ja-jp/tools/tools-console/commandlinetools/xtf-transport-errors.md)


## Related topics

- [その他の Xtf API (API の内容)](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/atoc-xtfapi.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)
- [XBOX タイトル向けの Title Performance Overlay](https://docs.xbox.com/ja-jp/tools/tools-console/titleperfoverlay/index.md)
- [XBOX Manager: アプリとファイルの管理](https://docs.xbox.com/ja-jp/tools/tools-console/xbom/manager-tool-managing-applications.md)