DismRemovePackage 函数
从映像中删除包。
语法
HRESULT WINAPI DismRemovePackage(
_In_ DismSession Session,
_In_ PCWSTR Identifier,
_In_ DismPackageIdentifier PackageIdentifier,
_In_opt_ HANDLE CancelEvent,
_In_opt_ DISM_PROGRESS_CALLBACK Progress,
_In_opt_ PVOID UserData
);
参数
Session [in]
一个有效的 DismSession。 DismSession 必须关联一个映像。 可以使用 DismOpenSession 将会话与映像关联。
Identifier [in]
.cab 文件的绝对路径或包名称，具体取决于 PackageIdentifier 参数值。
PackageIdentifier [in]
可选。 有效的 DismPackageIdentifier 枚举值。
| 值 | 说明 |
|---|---|
| PackageName | 要使用包名称指定包时，请使用此值。 |
| PackagePath | 要使用 .cab 文件的绝对路径指定包时，请使用此值。 |
| PackageNone | 不是此函数的有效值。 |
CancelEvent [in，可选]
可选。 可以设置此函数的 CancelEvent，以便在客户端发出信号时取消正在进行的操作。 如果在无法取消操作的阶段收到 CancelEvent，则该操作将继续并返回成功代码。 如果在收到 CancelEvent 后取消操作，则映像状态为未知。 应在继续操作之前验证映像状态，或者放弃更改并重新开始。
Progress [in，可选]
可选。 指向客户端定义的 DismProgressCallback 的指针。
UserData [in，可选]
可选。 用户定义的自定义数据。
返回值
如果成功，则返回 S_OK。
注解
DismRemovePackage 函数不支持 .msu 文件。
示例
HRESULT hr = S_OK;
hr = DismRemovePackage(Session, "C:\\packages\\test.CAB", PackagePath, NULL, NULL, NULL);
要求
| 要求 | 说明 |
|---|---|
| 支持的主机平台 | DISM API 可在 Windows 评估和部署工具包 (Windows ADK) 支持的任何操作系统上使用。 有关详细信息，请参阅 Windows ADK 技术参考。 |
| 支持的映像平台 | Windows 7、Windows Server 2008 R2、Windows PE 3.0、Windows 8、Windows Server 2012、Windows 预安装环境 (Windows PE) 4.0、Windows 8.1、Windows Server 2012 R2、Windows 10、Windows Server 2016 |
| 最低受支持的客户端 | Windows 7 [仅限桌面应用] |
| 最低受支持的服务器 | Windows Server 2008 R2 [仅限桌面应用] |
| 标头 | DismAPI.h |
| Library | DismAPI.lib |
| DLL | DismAPI.dll |