次の方法で共有

XPackageInstallChunks

  • [アーティクル]

チャンクのインストールを開始します。

構文

HRESULT XPackageInstallChunks(  
         const char* packageIdentifier,  
         uint32_t selectorCount,  
         XPackageChunkSelector* selectors,  
         uint32_t minimumUpdateIntervalMs,  
         bool suppressUserConfirmation,  
         XTaskQueueHandle queue,  
         XPackageInstallationMonitorHandle* installationMonitor  
)

パラメーター

packageIdentifier _In_z_
型: char*

ディスクにインストールされているパッケージを一意に識別する文字列。 パッケージ識別子の詳細については、「ダウンロード可能なコンテンツ (DLC) の管理とライセンス」を参照してください。

selectorCount _In_
型: uint32_t

selectors パラメーター内のセレクターの数。

selectors _In_reads_(selectorCount)
型: XPackageChunkSelector*

インストールするチャンクを指定するセレクターの配列。

minimumUpdateIntervalMs _In_
型: uint32_t

更新間の間隔 (ミリ秒単位)。

suppressUserConfirmation _In_
型: bool

インストールするチャンクがプリセット サイズを超えると、確認プロンプトが表示されます。 suppressUserConfirmation が true の場合、プロンプトは表示されず、ユーザーが受け入れた場合と同様にインストールは進行します。 これにより、ゲームで独自の UI を表示できます。 ゲームでこれを使用する場合は、ユーザーに提示されるサイズを取得するために、XPackageEstimateDownloadSize も呼び出す必要があります。 XPackageEstimateDownloadSize では、プロンプトを表示するのに十分なサイズかどうかを示すブール値も返されます。 ダウンロードの確認が必要な場合は、ゲーム独自の UI で表示するか、XPackageInstallChunks で表示する必要があります。

queue _In_opt_
型: XTaskQueueHandle

どの処理を実行するかについての非同期キュー。

installationMonitor _Out_
型: XPackageInstallationMonitorHandle*

戻ったとき、セレクターに一致するチャンクのインストールを監視するインストール モニターのハンドルが格納されます。

戻り値

型: HRESULT

HRESULT 成功またはエラー コード。
インストールが拒否された場合は、キャンセル エラーを返します。

解説

注意

この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。

チャンクのインストールでは、ダウンロード サイズを受け入れるようにユーザーに求めるメッセージが表示される場合があります。

  • この API の同期バージョンを使用する場合は、ユーザーがダウンロードを受け入れるか拒否するまでブロックします。 ユーザーが拒否した場合、呼び出しは失敗し、キャンセル エラー E_ABORT が発生します。 これにより、インストールのステータスを監視するために使用できるインストール モニターが返されます。 XPackageCloseInstallationMonitorHandle を呼び出すことによって、最終的にモニターを閉じる必要があります。
  • suppressUserConfirmation を true に設定すると、ユーザーにダウンロードのプロンプトを表示するカスタム UI を提供することができます。

この例では、"BigMaps" タグに対応するチャンクをインストールします。

void CALLBACK BigMapsInstallProgress(
    void* /* context */,
    XPackageInstallationMonitorHandle monitor)
{
    XPackageInstallationProgress progress;
    XPackageGetInstallationProgress(monitor, &progress);
    if (progress.completed)
    {
        printf("BigMaps Installed\n");
        XPackageCloseInstallationMonitorHandle(monitor);
    }
}

HRESULT InstallBigMaps(XTaskQueueHandle queue)
{
    char id[XPACKAGE_IDENTIFIER_MAX_LENGTH];
    HRESULT hr = XPackageGetCurrentProcessPackageIdentifier(_countof(id), id);
    if (FAILED(hr)) return hr;

    XPackageChunkSelector selector;
    selector.type = XPackageChunkSelectorType::Tag;
    selector.tag = "BigMaps";

    XPackageInstallationMonitorHandle monitor;
    hr = XPackageInstallChunks(id, 1, &selector, 1000, false, queue, &monitor);

    if (SUCCEEDED(hr))
    {
        XTaskQueueRegistrationToken token;
        hr = XPackageRegisterInstallationProgressChanged(
            monitor,
            nullptr,
            BigMapsInstallProgress,
            &token);

        if (FAILED(hr))
        {
            XPackageCloseInstallationMonitorHandle(monitor);
        }
    }

    return hr;
}

要件

ヘッダー: XPackage.h

ライブラリ: xgameruntime.lib

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

関連項目

XPackage