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, optional]
随意。 この関数の CancelEvent を設定すると、クライアントから通知されたときに進行中の操作を取り消すことができます。 操作を取り消すことができない段階で CancelEvent を受信した場合、操作は続行され、成功コードが返されます。 CancelEvent が受信され、操作が取り消された場合、イメージの状態は不明です。 変更を続行または破棄してもう一度開始する前に、イメージの状態を確認する必要があります。
Progress [in, optional]
随意。 クライアント定義の DismProgressCallback へのポインター。
UserData [in, optional]
随意。 ユーザー定義のカスタム データ。
戻り値
関数が成功した場合、戻り値は S_OK。 関数が成功すると、次のいずれかの値が返される場合もあります。
| リターン コード | 説明 |
|---|---|
|
セッション がオンラインの場合は、コンピューターを再起動する必要があります。 |
|
セッション を再読み込みする必要があります。 |
関数が失敗した場合、戻り値は HRESULT エラー値です。
解説
DismRemovePackage 関数は.msu ファイルをサポートしていません。
例
HRESULT hr = S_OK;
hr = DismRemovePackage(Session, "C:\\packages\\test.CAB", PackagePath, NULL, NULL, NULL);
必要条件
| 要件 | 説明 |
|---|---|
| サポートされているホスト プラットフォーム | DISM API は、Windows Assessment and Deployment Kit (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 [デスクトップ アプリのみ] |
| ヘッダ | DismAPI.h |
| 図書館 | DismAPI.lib |
| DLL | DismAPI.dll |