Função MsiEnumProductsA (msi.h)

A função MsiEnumProducts enumera todos os produtos atualmente anunciados ou instalados. Os produtos instalados no contexto de instalação por usuário e por computador e anúncios são enumerados.

Sintaxe

UINT MsiEnumProductsA(
  [in]  DWORD iProductIndex,
  [out] LPSTR lpProductBuf
);

Parâmetros

[in] iProductIndex

Especifica o índice do produto a ser recuperado. Esse parâmetro deve ser zero para a primeira chamada para a função MsiEnumProducts e incrementado para chamadas subsequentes. Como os produtos não são ordenados, qualquer novo produto terá um índice arbitrário. Isso significa que a função pode retornar produtos em qualquer ordem.

[out] lpProductBuf

Ponteiro para um buffer que recebe o código do produto. Esse buffer deve ter 39 caracteres. Os primeiros 38 caracteres são para o GUID e o último caractere é para o caractere nulo de terminação.

Valor retornado

Valor	Significado
ERROR_BAD_CONFIGURATION	Os dados de configuração estão corrompidos.
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função.
ERROR_NO_MORE_ITEMS	Não há produtos a serem retornados.
ERROR_NOT_ENOUGH_MEMORY	O sistema não tem memória suficiente para concluir a operação. Disponível com o Windows Server 2003.
ERROR_SUCCESS	Um valor foi enumerado.

Comentários

Para enumerar produtos, um aplicativo deve inicialmente chamar a função MsiEnumProducts com o parâmetro iProductIndex definido como zero. Em seguida, o aplicativo deve incrementar o parâmetro iProductIndex e chamar MsiEnumProducts até que não haja mais produtos (até que a função retorne ERROR_NO_MORE_ITEMS).

Ao fazer várias chamadas para MsiEnumProducts para enumerar todos os produtos, cada chamada deve ser feita do mesmo thread.

Observação

O cabeçalho msi.h define MsiEnumProducts 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

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. Confira os Requisitos de tempo de execução do Windows Installer para obter informações sobre o service pack mínimo do Windows exigido por uma versão do Windows Installer.
Plataforma de Destino	Windows
Cabeçalho	msi.h
Biblioteca	Msi.lib
DLL	Msi.dll

Confira também

Determinar o contexto de instalação

Funções de status do sistema