DismCheckImageHealth function
Checks whether the image can be serviced or is corrupted.
Syntax
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
);
Parameters
Session [in]
A valid DismSession. The DismSession must be associated with an image. You can associate a session with an image by using the DismOpenSession.
ScanImage [in]
A Boolean value that specifies whether to scan the image or just check for flags from a previous scan.
| Value | Description |
|---|---|
| TRUE | Scan the image and flag it if it is corrupted. |
| FALSE | Check if the image has been flagged as corrupted. You can use this value if the image has already been scanned. |
CancelEvent [in, optional]
Optional. You can set a CancelEvent for this function in order to cancel the operation in progress when signaled by the client. If the CancelEvent is received at a stage when the operation cannot be canceled, the operation will continue and return a success code. If the CancelEvent is received and the operation is canceled, the image state is unknown. You should verify the image state before continuing or discard the changes and start again.
Progress [in, optional]
Optional. A pointer to a client-defined DismProgressCallback.
UserData [in, optional]
Optional. User defined custom data.
ImageHealth [out]
A pointer to the DismImageHealthState enumeration. The enumeration value is set during this operation.
Return value
Returns S_OK on success.
Remarks
If ScanImage is set to True, this function will take longer to finish.
Example
HRESULT hr = S_OK;
DismImageHealthState state;
hr = DismCheckImageHealth(Session, TRUE, NULL, NULL, NULL, &state);
Requirements
| Requirement | Description |
|---|---|
| Supported host platforms | DISM API can be used on any operating system supported by the Windows Assessment and Deployment Kit (Windows ADK). For more information, see the Windows ADK Technical Reference. |
| Supported image platforms | Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows 10, Windows Server 2016 |
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Header | DismAPI.h |
| Library | DismAPI.lib |
| DLL | DismAPI.dll |