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]
PackageIdentifier パラメーター値に応じて、.cab ファイルへの絶対パスまたはパッケージ名のいずれか。
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 [デスクトップ アプリのみ] |
| Header | DismAPI.h |
| ライブラリ | DismAPI.lib |
| [DLL] | DismAPI.dll |