DismCheckImageHealth 函数

检查映像是可维护还是已损坏。

语法

HRESULT WINAPI WINAPI DismCheckImageHealth(
  _In_     DismSession            Session,
  _In_     BOOL                   ScanImage,
  _In_opt_ HANDLE                 CancelEvent,
  _In_opt_ DISM_PROGRESS_CALLBACK Progress,
  _In_opt_ PVOID                  UserData,
  _Out_    DismImageHealthState   *ImageHealth
);

参数

Session [in]
一个有效的 DismSession。 DismSession 必须关联一个映像。 可以使用 DismOpenSession 将会话与映像关联。

ScanImage [in]
一个布尔值,它指定是扫描映像还是仅检查来自上次扫描的标志。

说明
TRUE 扫描映像并在映像已损坏时对其进行标记。
FALSE 检查映像是否已标记为已损坏。 如果已扫描映像,则可以使用此值。

CancelEvent [in,可选]
可选。 可以设置此函数的 CancelEvent,以便在客户端发出信号时取消正在进行的操作。 如果在无法取消操作的阶段收到 CancelEvent,则该操作将继续并返回成功代码。 如果在收到 CancelEvent 后取消操作,则映像状态为未知。 应在继续操作之前验证映像状态,或者放弃更改并重新开始。

Progress [in,可选]
可选。 指向客户端定义的 DismProgressCallback 的指针。

UserData [in,可选]
可选。 用户定义的自定义数据。

ImageHealth [out]
指向 DismImageHealthState 枚举的指针。 枚举值是在此操作期间设置的。

返回值

成功时返回 S_OK

注解

如果将 ScanImage 设置为 True,则此函数需要更长时间才能完成。

示例

HRESULT hr = S_OK;
DismImageHealthState state;
hr = DismCheckImageHealth(Session, TRUE, NULL, NULL, NULL, &state);

要求

要求 说明
支持的主机平台 DISM API 可在 Windows 评估和部署工具包 (Windows ADK) 支持的任何操作系统上使用。 有关详细信息,请参阅 Windows ADK 技术参考
支持的映像平台 Windows 8、Windows Server 2012、Windows 8.1、Windows Server 2012 R2、Windows 10、Windows Server 2016
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
标头 DismAPI.h
Library DismAPI.lib
DLL DismAPI.dll

另请参阅

DismRestoreImageHealth

DismImageHealthState

DISM API 常量