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
);
參數
會話 [in]
有效的 DismSession。 DismSession 必須與影像相關聯。 您可以使用 DismOpenSession將會話與映射產生關聯。
ScanImage [in]
布林值，指定是否要掃描影像，或只檢查先前掃描中的旗標。
| 值 | 描述 |
|---|---|
| true | 掃描影像，並在影像損毀時加上旗標。 |
| false | 檢查影像是否已標示為損毀。 如果已掃描影像，您可以使用此值。 |
CancelEvent [in， optional]
選擇性。 您可以為此函式設定 CancelEvent ，以便在用戶端發出訊號時取消進行中的作業。 如果在無法取消作業的階段收到 CancelEvent ，作業將會繼續並傳回成功碼。 如果收到 CancelEvent 並取消作業，則映射狀態為未知。 您應該先確認映射狀態，再繼續或捨棄變更，然後再啟動一次。
進度 [in， 選擇性]
選擇性。 用戶端定義 DismProgressCallback的指標。
UserData [in， optional]
選擇性。 使用者定義的自訂資料。
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 |
| 程式庫 | DismAPI.lib |
| DLL | DismAPI.dll |