Função MsiGetComponentStateA (msiquery.h)

A função MsiGetComponentState obtém o estado de um componente.

Sintaxe

UINT MsiGetComponentStateA(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCSTR       szComponent,
  [out] INSTALLSTATE *piInstalled,
  [out] INSTALLSTATE *piAction
);

Parâmetros

[in] hInstall

Manipule para a instalação fornecida a uma ação personalizada de DLL ou obtida por meio de MsiOpenPackage, MsiOpenPackageEx ou MsiOpenProduct.

[in] szComponent

Uma cadeia de caracteres terminada em nulo que especifica o nome do componente dentro do produto.

[out] piInstalled

Recebe o estado atual instalado. Esse parâmetro não deve ser null. Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
INSTALLSTATE_ABSENT
O componente não está instalado.
INSTALLSTATE_DEFAULT
O componente é instalado no local padrão: local ou de origem.
INSTALLSTATE_LOCAL
O componente é instalado na unidade local.
INSTALLSTATE_REMOVED
O componente está sendo removido. Em estado de ação e não configurável.
INSTALLSTATE_SOURCE
O componente é executado da origem, CD-ROM ou rede.
INSTALLSTATE_UNKNOWN
Um nome de produto ou recurso não reconhecido foi passado para a função.

[out] piAction

Recebe a ação executada durante a instalação. Esse parâmetro não deve ser null. Para obter valores retornados, consulte piInstalled.

Retornar valor

A função MsiGetComponentState retorna os seguintes valores:

Comentários

Se a função falhar, você poderá obter informações de erro estendidas usando MsiGetLastErrorRecord.

Para obter mais informações, consulte Chamando funções de banco de dados de programas.

Observação

O cabeçalho msiquery.h define MsiGetComponentState como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Installer 5.0 no Windows Server 2012, no Windows 8, no Windows Server 2008 R2 ou no Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 no Windows Server 2008 ou no Windows Vista. Windows Installer no Windows Server 2003 ou no Windows XP
Plataforma de Destino Windows
Cabeçalho msiquery.h
Biblioteca Msi.lib
DLL Msi.dll

Confira também

Funções de seleção do instalador

Passando Null como o argumento das funções do Windows Installer