XPackageUninstallPackage
指定されたパッケージをアンインストールします。
構文
bool XPackageUninstallPackage(
const char* packageIdentifier)
noexcept;
パラメーター
packageIdentifier _In_z_
型: char*
ディスクにインストールされているパッケージを一意に識別する文字列。 パッケージ識別子の詳細については、「ダウンロード可能なコンテンツ (DLC) の管理とライセンス」を参照してください。
戻り値
型: bool
Bool 値は、パッケージが正常にアンインストールされたかどうかを示します。
解説
注意
この関数は、時間依存のスレッドで呼び出すのに安全ではありません。 詳細については、「時間依存のスレッド」を参照してください。
XPackageUninstallPackage は、指定されたパッケージをアンインストールします。 指定されたパッケージ識別子は、 XPackageEnumeratePackages またはパッケージ識別子を返す別の API から返されます。 XPackageUninstallPackage は、 パッケージがアンインストールされた場合は true を返し、パッケージをアンインストールできなかった場合は false を返します。
パッケージのアンインストールに失敗する理由には次のようなものがあります。
- パッケージは使用中です。 たとえば、ゲームが現在マウントしている DLC パッケージです。
- ゲームは xCloud サーバーで実行されています。 パッケージのインストールと削除は、サーバー環境の責任です。
次の例では、 XPackageUninstallPackage を使用してパッケージをアンインストールし、ユーザー向けディスクの開きスペースを増やします。
bool UninstallDlcToReclaimDiskSpace(const char_t* packageIdentifier)
{
return XPackageUninstallPackage(packageIdentifier);
}
要件
ヘッダー: XPackage.h
ライブラリ: xgameruntime.lib
サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体