DismRemovePackage function

Removes a package from an image.


HRESULT WINAPI DismRemovePackage(
  _In_     DismSession            Session,
  _In_     PCWSTR                 Identifier,
  _In_     DismPackageIdentifier  PackageIdentifier,
  _In_opt_ HANDLE                 CancelEvent,
  _In_opt_ PVOID                  UserData


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.

Identifier [in]
Either an absolute path to a .cab file or the package name, depending on the PackageIdentifier parameter value.

PackageIdentifier [in]
Optional. A valid DismPackageIdentifier enumeration value.

Value Description
PackageName Use this value when you want to specify a package by using the package name.
PackagePath Use this value when you want to specify a package by using an absolute path to a .cab file.
PackageNone Not a valid value for this function.

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.

Return value

Returns S_OK on success.


The DismRemovePackage function does not support .msu files.


hr = DismRemovePackage(Session, "C:\\packages\\test.CAB", PackagePath, NULL, NULL, NULL);


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 7, Windows Server 2008 R2, Windows PE 3.0, Windows 8, Windows Server 2012, Windows Preinstallation Environment (Windows PE) 4.0, Windows 8.1, Windows Server 2012 R2, Windows 10, Windows Server 2016
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header DismAPI.h
Library DismAPI.lib
DLL DismAPI.dll

See also