Referência de função do instalador

Para habilitar o Windows Installer no seu aplicativo, você deve usar as funções do instalador. As tabelas neste tópico identificam as funções por categoria.

Interface do usuário e funções de log

Nome Descrição
MsiSetInternalUI Habilita a interface do usuário interna do instalador.
MsiSetExternalUI Habilita um manipulador de interface do usuário externo que recebe mensagens em um formato de cadeia de caracteres.
MsiSetExternalUIRecord Habilita um manipulador de interface do usuário externo que recebe mensagens em um formato de registro.
MsiEnableLog Define o modo de log para todas as instalações no processo de chamada.

 

Funções de Gerenciamento de Identificadores

Nome Descrição
MsiCloseHandle Fecha um identificador de instalação aberto.
MsiCloseAllHandles Fecha todos os identificadores de instalação abertos. Não use para limpeza.

 

Funções de instalação e configuração

Nome Descrição
MsiAdvertiseProduct Anuncia um produto.
MsiAdvertiseProductEx Anuncia um produto.
MsiAdvertiseScript Copia um arquivo de script de anúncio em locais especificados.
MsiInstallProduct Instala ou remove um aplicativo ou pacote de aplicativos.
MsiConfigureProduct Instala ou remove um aplicativo ou pacote de aplicativos.
MsiConfigureProductEx Instala ou remove um aplicativo ou pacote de aplicativos. Uma linha de comando do produto pode ser especificada.
MsiReinstallProduct Reinstala ou repara uma instalação.
MsiConfigureFeature Configura o estado instalado de um recurso.
MsiReinstallFeature Valida ou repara recursos.
MsiInstallMissingComponent Instala componentes ausentes.
MsiInstallMissingFile Instala arquivos ausentes.
MsiNotifySidChange Notifica e atualiza as informações internas do Windows Installer com alterações nos SIDs do usuário. Disponível a partir do Windows Installer 3.1.
MsiProcessAdvertiseScript Processa um arquivo de script de anúncio em locais especificados.
MsiSourceListAddSource Adiciona ou reordena as fontes de um patch ou produto em um contexto especificado.
MsiSourceListAddSourceEx Adiciona ou reordena as fontes de um patch ou produto em um contexto especificado. Cria uma lista de origem para um patch que não existe em um contexto especificado. Disponível no Windows Installer 3.0.
MsiSourceListClearSource Remove uma fonte existente para um produto ou patch em um contexto especificado. Disponível no Windows Installer 3.0.
MsiSourceListClearAll Remove todas as fontes existentes de um tipo de origem específico para uma instância de produto especificada.
MsiSourceListClearAllEx Remove todas as fontes existentes de um tipo de origem específico para uma instância de produto especificada. Disponível no Windows Installer 3.0.
MsiSourceListForceResolution Remove o registro da fonte atual do produto ou patch, que é registrado como a propriedade "LastUsedSource". Essa função não afeta a lista de fontes registrada.
MsiSourceListForceResolutionEx Remove o registro da fonte atual do produto ou patch, que é registrado como a propriedade "LastUsedSource". Essa função não afeta a lista de fontes registrada. Disponível no Windows Installer 3.0.
MsiSourceListGetInfo Recupera informações sobre a lista de origem de um produto ou patch em um contexto específico.
MsiSourceListSetInfo Define a origem usada mais recentemente para um produto ou patch em um contexto especificado. Disponível no Windows Installer 3.0.
MsiSourceListEnumMediaDisks Enumera a lista de discos registrados para a fonte de mídia para um patch ou produto. Disponível no Windows Installer 3.0.
MsiSourceListAddMediaDisk Adiciona ou atualiza um disco da fonte de mídia de um produto ou patch registrado. Disponível no Windows Installer 3.0.
MsiSourceListClearMediaDisk Remove um disco registrado existente na fonte de mídia para um produto ou patch em um contexto específico. Disponível no Windows Installer 3.0.
MsiSourceListEnumSources Enumera as fontes na lista de origem de um patch ou produto especificado. Disponível no Windows Installer 3.0.

 

Funções específicas do componente

Nome Descrição
MsiProvideAssembly Instala e retorna o caminho completo do componente de um assembly.
MsiProvideComponent Instala e retorna o caminho completo do componente de um componente.
MsiProvideQualifiedComponent Instala e retorna o caminho completo do componente de um componente qualificado.
MsiProvideQualifiedComponentEx Instala e retorna o caminho completo de um componente qualificado publicado por um produto.
MsiGetComponentPath Retorna o caminho completo ou a chave do registro para um componente instalado.
MsiGetComponentPathEx Retorna o caminho completo ou a chave do registro para um componente instalado entre contas de usuário e o contexto de instalação. Windows Installer 4.5 e versões anteriores: sem suporte.
MsiLocateComponent Retorna o caminho completo para um componente instalado sem um código de produto.
MsiQueryComponentState Retorna o estado instalado de um componente. Pode consultar componentes de uma instância de um produto instalado em contas de usuário diferentes do usuário atual. Disponível no Windows Installer 3.0 ou posterior.

 

Funções somente do aplicativo

Nome Descrição
MsiCollectUserInfo Armazena informações do usuário de um assistente de instalação.
MsiUseFeature Incrementa a contagem de uso de um recurso e indica o estado de instalação.
MsiUseFeatureEx Incrementa a contagem de uso de um recurso e indica o estado de instalação.
MsiGetProductCode Retorna o código do produto usando o código do componente.

 

Funções de status do sistema

Nome Descrição
MsiEnumProducts Enumera os produtos anunciados.
MsiEnumProductsEx Enumera todas as instâncias de produtos anunciados ou instalados em um contexto especificado. Disponível no Windows Installer 3.0 ou posterior.
MsiEnumRelatedProducts Enumera os produtos instalados no momento com um código de atualização especificado.
MsiEnumFeatures Enumera os recursos publicados.
MsiEnumComponents Enumera os componentes instalados.
MsiEnumComponentsEx Enumera os componentes instalados entre contas de usuário e o contexto de instalação. Windows Installer 4.5 e versões anteriores: sem suporte.
MsiEnumClients Enumera os clientes de um componente instalado.
MsiEnumClientsEx Enumera os clientes de um componente instalado entre contas de usuário e o contexto de instalação. Windows Installer 4.5 e versões anteriores: sem suporte.
MsiEnumComponentQualifiers Enumera os qualificadores anunciados de um componente.
MsiQueryFeatureState Retorna o estado instalado de um recurso.
MsiQueryFeatureStateEx Retorna o estado instalado de um recurso de produto. Pode consultar recursos de uma instância de um produto instalado em contas de usuário diferentes do usuário atual. Disponível no Windows Installer 3.0 ou posterior.
MsiQueryProductState Retorna o estado instalado de um aplicativo ou pacote de aplicativos.
MsiGetFeatureUsage Retorna as métricas de uso de um recurso.
MsiGetProductInfo Retorna as informações do produto de produtos publicados e instalados.
MsiGetProductInfoEx Retorna as informações do produto de produtos anunciados e instalados. Pode recuperar informações sobre uma instância de um produto instalado em uma conta de usuário diferente do usuário atual. Disponível no Windows Installer 3.0 ou posterior.
MsiGetUserInfo Retorna as informações de usuário registradas para um produto instalado.

 

Funções de consulta de produto

Nome Descrição
MsiOpenProduct Abre um produto para usar com as funções que acessam o banco de dados.
MsiOpenPackage Abre um pacote a ser usado com as funções que acessam o banco de dados.
MsiOpenPackageEx Abre um pacote a ser usado com as funções que acessam o banco de dados.
MsiIsProductElevated Verifica se o produto foi instalado com privilégios elevados.
MsiGetProductInfoFromScript Retorna as informações do produto de um arquivo de script do instalador.
MsiGetProductProperty Recupera as propriedades no banco de dados do produto.
MsiGetShortcutTarget Examina um atalho e retorna o produto, o nome do recurso e o componente, se disponível.
MsiGetFeatureInfo Retorna as informações descritivas de um recurso.
MsiVerifyPackage Verifica se um arquivo especificado é um pacote de instalação.

 

Funções de aplicação de patch

Nome Descrição
MsiApplyPatch Invoca uma instalação e aplica um pacote de patch.
MsiEnumPatches Retorna o GUID de cada patch aplicado a um produto e uma lista de transformações de cada patch que se aplicam ao produto.
MsiGetPatchInfo Retorna informações sobre um patch.
MsiRemovePatches Desinstala um patch de um produto. Disponível no Windows Installer 3.0.
MsiDeterminePatchSequence Determina a melhor sequência de aplicativos para um conjunto de patches e produto. Disponível no Windows Installer 3.0.
MsiApplyMultiplePatches Aplica um ou mais patches a produtos. Disponível no Windows Installer 3.0.
MsiEnumPatchesEx Enumera todos os patches aplicados a um produto em um contexto específico ou em todos os contextos. Disponível no Windows Installer 3.0.
MsiGetPatchFileList Quando fornecida uma lista de arquivos .msp, essa função recupera a lista de arquivos que podem ser atualizados pelos patches para o destino. Disponível no Windows Installer 4.0.
MsiGetPatchInfoEx Consulta as informações sobre a aplicação de um patch especificado para um produto especificado. Disponível no Windows Installer 3.0.
MsiExtractPatchXMLData Extrai as informações de um patch. Disponível no Windows Installer 3.0.
MsiDetermineApplicablePatches Determina o melhor conjunto de patches necessários para atualizar um produto ou conjunto de produtos. Disponível no Windows Installer 3.0.

 

Funções de consulta de arquivo

Nome Descrição
MsiGetFileHash Usa o caminho para um arquivo e retorna um hash de 128 bits desse arquivo.
MsiGetFileSignatureInformation Usa o caminho para um arquivo que foi assinado digitalmente e retorna o certificado de signatário e o hash do arquivo.
MsiGetFileVersion Retorna a cadeia de caracteres de versão e a cadeia de caracteres de idioma.

 

Funções de gerenciamento de transações

Nome Descrição
MsiBeginTransaction Inicia o processamento de transações de uma instalação de vários pacotes e retorna um identificador para a transação. Essa função está disponível a partir do Windows Installer 4.5.
MsiJoinTransaction Solicita que o Windows Installer torne o processo atual o proprietário da transação, fazendo uma instalação de vários pacotes. Essa função está disponível a partir do Windows Installer 4.5.
MsiEndTransaction Confirma ou reverte todas as instalações pertencentes à transação. Essa função está disponível a partir do Windows Installer 4.5.

 

Funções de banco de dados

Além das funções do Windows Installer identificadas nas tabelas anteriores, você pode manipular informações no banco de dados de instalação usando as funções de acesso do banco de dados descritas na seção Funções de Banco de Dados.

Estruturas do Installer

Além disso, algumas informações no banco de dados de instalação são tratadas usando as estruturas descritas na seção Estruturas do Instalador.