Partilhar via


Função DismRemovePackage

Remove um pacote de uma imagem.

Sintaxe

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
);

Parâmetros

Sessão [em]
Um válido DismSession. O DismSession deve estar associado a uma imagem. Você pode associar uma sessão a uma imagem usando o DismOpenSession.

Identificador [in]
Um caminho absoluto para um arquivo .cab ou o nome do pacote, dependendo do valor do parâmetro PackageIdentifier.

IdentificadorDePacote [em]
Opcional. Um válido DismPackageIdentifier valor de enumeração.

Valor Descrição
PackageName Use esse valor quando quiser especificar um pacote usando o nome do pacote.
Caminho do Pacote Use esse valor quando quiser especificar um pacote usando um caminho absoluto para um arquivo .cab.
PacoteNenhum Não é um valor válido para esta função.

CancelEvento [in, opcional]
Opcional. Você pode definir um CancelEvent para esta função, a fim de cancelar a operação em andamento quando sinalizado pelo cliente. Se o CancelEvent for recebido em um estágio em que a operação não pode ser cancelada, a operação continuará e retornará um código de sucesso. Se o CancelEvent for recebido e a operação for cancelada, o estado da imagem será desconhecido. Você deve verificar o estado da imagem antes de continuar ou descartar as alterações e começar novamente.

Progresso [em, opcional]
Opcional. Um ponteiro para um definido pelo cliente DismProgressCallback.

UserData [in, opcional]
Opcional. Dados personalizados definidos pelo usuário.

Valor de retorno

Se a função for bem-sucedida, o valor de retorno será S_OK. A função também pode retornar um dos seguintes valores quando for bem-sucedida:

Código de retorno Descrição
(HRESULT)ERROR_SUCCESS_REBOOT_REQUIRED
Se a Sessão estiver online, o computador precisará ser reiniciado.
DISMAPI_S_RELOAD_IMAGE_SESSION_REQUIRED
A sessão precisa ser recarregada.

Se a função falhar, o valor de retorno é um valor de erro HRESULT.

Comentários

A função DismRemovePackage não suporta arquivos .msu.

Exemplo

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

Requerimentos

Exigência Descrição
Plataformas de host suportadas A API DISM pode ser usada em qualquer sistema operacional suportado pelo Kit de Avaliação e Implantação do Windows (Windows ADK). Para obter mais informações, consulte a Referência Técnica do Windows ADK .
Plataformas de imagem suportadas Windows 7, Windows Server 2008 R2, Windows PE 3.0, Windows 8, Windows Server 2012, Ambiente de Pré-instalação do Windows (Windows PE) 4.0, Windows 8.1, Windows Server 2012 R2, Windows 10, Windows Server 2016
Cliente mínimo suportado Windows 7 [apenas aplicações de ambiente de trabalho]
Servidor mínimo suportado Windows Server 2008 R2 [apenas aplicações de ambiente de trabalho]
Cabeçalho DismAPI.h
Biblioteca DismAPI.lib
DLL DismAPI.dll

Ver também

DismAddPackage

DismGetPackages

DismRemoveDriver

DismDisableFeature