Função MsiGetFeatureInfoA (msi.h)

A função MsiGetFeatureInfo retorna informações descritivas para um recurso.

Sintaxe

UINT MsiGetFeatureInfoA(
  [in]                MSIHANDLE hProduct,
  [in]                LPCSTR    szFeature,
  [out, optional]     LPDWORD   lpAttributes,
  [out, optional]     LPSTR     lpTitleBuf,
  [in, out, optional] LPDWORD   pcchTitleBuf,
  [out, optional]     LPSTR     lpHelpBuf,
  [in, out, optional] LPDWORD   pcchHelpBuf
);

Parâmetros

[in] hProduct

Manipule para o produto que possui o recurso. Esse identificador é obtido de MsiOpenProduct.

[in] szFeature

Código de recurso para o recurso sobre quais informações devem ser retornadas.

[out, optional] lpAttributes

Ponteiro para um local que contém um ou mais dos sinalizadores de atributo a seguir.

INSTALLFEATUREATTRIBUTE_FAVORLOCAL (1)

INSTALLFEATUREATTRIBUTE_FAVORSOURCE (2)

INSTALLFEATUREATTRIBUTE_FOLLOWPARENT (4)

INSTALLFEATUREATTRIBUTE_FAVORADVERTISE (8)

INSTALLFEATUREATTRIBUTE_DISALLOWADVERTISE (16)

INSTALLFEATUREATTRIBUTE_NOUNSUPPORTEDADVERTISE (32)

Para obter mais informações, consulte
Tabela de recursos. Os valores que MsiGetFeatureInfo retorna são o dobro dos valores na coluna Atributos da Tabela de Recursos.

[out, optional] lpTitleBuf

Ponteiro para um buffer para receber o nome localizado do recurso, que corresponde ao campo Título na Tabela de Recursos.

Esse parâmetro é opcional e pode ser nulo.

[in, out, optional] pcchTitleBuf

Como entrada, o tamanho de lpTitleBuf. Como saída, o número de caracteres retornados em lpTitleBuf. Na entrada, esse é o tamanho total do buffer e inclui um espaço para um caractere nulo de terminação. Se o buffer passado for muito pequeno, a contagem retornada não incluirá o caractere nulo de terminação.

[out, optional] lpHelpBuf

Ponteiro para um buffer para receber a descrição localizada do recurso, que corresponde ao campo Descrição do recurso na tabela Recurso. Esse parâmetro é opcional e pode ser nulo.

[in, out, optional] pcchHelpBuf

Como entrada, o tamanho de lpHelpBuf. Como saída, o número de caracteres retornados em lpHelpBuf. Na entrada, esse é o tamanho total do buffer e inclui um espaço para um caractere nulo de terminação. Se o buffer passado for muito pequeno, a contagem retornada não incluirá o caractere nulo de terminação.

Valor retornado

Código de retorno	Descrição
ERROR_INVALID_HANDLE	O identificador do produto é inválido.
ERROR_INVALID_PARAMETER	Um dos parâmetros é inválido.
ERROR_MORE_DATA	Um buffer é muito pequeno para armazenar os dados solicitados.
ERROR_SUCCESS	A função retorna com êxito.
ERROR_UNKNOWN_FEATURE	O recurso não é conhecido.

Comentários

Os tamanhos de buffer para a função MsiGetFeatureInfo devem incluir um caractere extra para o caractere nulo de terminação. Se um buffer for muito pequeno, a cadeia de caracteres retornada será truncada com nulo e o tamanho do buffer conterá o número de caracteres em toda a cadeia de caracteres, não incluindo o caractere nulo de terminação. Para obter mais informações, consulte Chamando funções de banco de dados de programas.

Observação

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

Funções de consulta de produto