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
);
參數
會話 [in]
有效的 DismSession。 DismSession 必須與映射相關聯。 您可以使用 DismOpenSession將會話與映射產生關聯。
識別碼 [in]
視 PackageIdentifier 參數值而定，.cab檔案或封裝名稱的絕對路徑。
PackageIdentifier [in]
選擇性。 有效的 DismPackageIdentifier 列舉值。
| 值 | 描述 |
|---|---|
| PackageName | 當您想要使用套件名稱指定封裝時，請使用此值。 |
| PackagePath | 當您想要使用.cab檔案的絕對路徑來指定封裝時，請使用此值。 |
| PackageNone | 不是這個函式的有效值。 |
CancelEvent [in， optional]
選擇性。 您可以設定此函式的 CancelEvent ，以便在用戶端發出訊號時取消進行中的作業。 如果在無法取消作業的階段收到 CancelEvent ，作業將會繼續並傳回成功碼。 如果收到 CancelEvent 且作業已取消，映射狀態為未知。 您應該先確認映射狀態，再繼續或捨棄變更，然後再開始一次。
進度 [in， 選擇性]
選擇性。 用戶端定義 DismProgressCallback的指標。
UserData [in， optional]
選擇性。 使用者定義的自訂資料。
傳回值
傳回成功 時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 [僅限傳統型應用程式] |
| 標頭 | DismAPI.h |
| 程式庫 | DismAPI.lib |
| DLL | DismAPI.dll |