Função MsiEnumFeaturesA (msi.h)

  • Artigo

A função MsiEnumFeatures enumera os recursos publicados para um determinado produto. Essa função recupera uma ID de recurso cada vez que é chamada.

Sintaxe

UINT MsiEnumFeaturesA(
  [in]  LPCSTR szProduct,
  [in]  DWORD  iFeatureIndex,
  [out] LPSTR  lpFeatureBuf,
  [out] LPSTR  lpParentBuf
);

Parâmetros

[in] szProduct

Cadeia de caracteres terminada em nulo especificando o código do produto cujos recursos devem ser enumerados.

[in] iFeatureIndex

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

[out] lpFeatureBuf

Ponteiro para um buffer que recebe a ID do recurso. O tamanho do buffer deve conter um valor de cadeia de caracteres de comprimento MAX_FEATURE_CHARS+1. A função retornará ERROR_MORE_DATA se o comprimento da ID do recurso exceder MAX_FEATURE_CHARS.

[out] lpParentBuf

Ponteiro para um buffer que recebe a ID do recurso pai do recurso. O tamanho do buffer deve conter um valor de cadeia de caracteres de comprimento MAX_FEATURE_CHARS+1. Se o comprimento da ID do recurso pai exceder MAX_FEATURE_CHARS, somente os primeiros caracteres MAX_FEATURE_CHARS serão copiados para o buffer.

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_MORE_DATA
 Um buffer é muito pequeno para conter os dados solicitados.
ERROR_NO_MORE_ITEMS
 Não há recursos a serem retornados.
ERROR_SUCCESS
 Um valor foi enumerado.
ERROR_UNKNOWN_PRODUCT
 O produto especificado é desconhecido.
 
 

Comentários

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

Observação

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

Funções de status do sistema