Função MsiEnumRelatedProductsA (msi.h)

Artigo
11/20/2024

A função MsiEnumRelatedProducts enumera produtos com um código de atualização especificado. Essa função lista os produtos atualmente instalados e anunciados que têm a propriedade UpgradeCode especificada na tabela Property.

Sintaxe

UINT MsiEnumRelatedProductsA(
  [in]  LPCSTR lpUpgradeCode,
  [in]  DWORD  dwReserved,
  [in]  DWORD  iProductIndex,
  [out] LPSTR  lpProductBuf
);

Parâmetros

[in] lpUpgradeCode

A cadeia de caracteres terminada em nulo que especifica o código de atualização de produtos relacionados que o instalador deve enumerar.

[in] dwReserved

Esse parâmetro é reservado e deve ser 0.

[in] iProductIndex

O índice baseado em zero nos produtos registrados.

[out] lpProductBuf

Um buffer para receber o GUID do 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 de retorno

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 a partir do Windows Server 2003.
ERROR_SUCCESS	Um valor foi enumerado.

Observações

Consulte a propriedade UpgradeCode.

Para enumerar produtos atualmente instalados e anunciados que tenham um código de atualização específico, um aplicativo deve inicialmente chamar a função MsiEnumRelatedProducts com o parâmetro iProductIndex definido como zero. Em seguida, o aplicativo deve incrementar o parâmetro iProductIndex e chamar MsiEnumRelatedProducts até que a função retorne ERROR_NO_MORE_ITEMS, o que significa que não há mais produtos com o código de atualização especificado.

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

Nota

O cabeçalho msi.h define MsiEnumRelatedProducts 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. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Installer 5.0 no Windows Server 2012, Windows 8, Windows Server 2008 R2 ou Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 no Windows Server 2008 ou Windows Vista. Windows Installer no Windows Server 2003 ou Windows XP. Consulte os Requisitos de Run-Time do Windows Installer para obter informações sobre o service pack mínimo do Windows exigido por uma versão do Windows Installer.
da Plataforma de Destino	Windows
cabeçalho	msi.h
biblioteca	Msi.lib
de DLL	Msi.dll

Compartilhar via