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 主机

另请参阅

XPackage
流式安装和智能交付