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 [デスクトップ アプリのみ] |
| Header | DismAPI.h |
| ライブラリ | DismAPI.lib |
| [DLL] | DismAPI.dll |