Função MsiSummaryInfoGetPropertyA (msiquery.h)

A função MsiSummaryInfoGetProperty obtém uma única propriedade do fluxo de informações de resumo.

Nota O significado do valor da propriedade depende se o fluxo de informações de resumo é para um banco de dados de instalação (arquivo .msi), transformação (arquivo .mst) ou patch (arquivo .msp). Consulte Summary Property Descriptions and Summary Information Stream Property Set para obter mais informações sobre as propriedades de informações de resumo.

 

Sintaxe

UINT MsiSummaryInfoGetPropertyA(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

Parâmetros

[in] hSummaryInfo

Manipular para obter informações resumidas.

[in] uiProperty

Especifica a ID da propriedade de resumo. Esse parâmetro pode ser uma ID de propriedade listada no conjunto de propriedades Stream informações de resumo. Essa função não retorna valores para PID_DICTIONARY propriedade OR PID_THUMBNAIL.

[out] puiDataType

Recebe o tipo de propriedade retornado. Esse parâmetro pode ser um tipo listado no
Informações resumidas Stream conjunto de propriedades.

[out] piValue

Recebe os dados de propriedade inteiro retornados.

[out] pftValue

Ponteiro para um valor de arquivo.

[out] szValueBuf

Ponteiro para o buffer que recebe o valor da propriedade de informações de resumo terminadas em nulo. Não tente determinar o tamanho do buffer passando um nulo (value=0) para szValueBuf. Você pode obter o tamanho do buffer passando uma cadeia de caracteres vazia (por exemplo, ""). Em seguida, a função retorna ERROR_MORE_DATA e pcchValueBuf contém o tamanho do buffer necessário em TCHARs, sem incluir o caractere nulo de terminação. No retorno de ERROR_SUCCESS, pcchValueBuf contém o número de TCHARs gravados no buffer, sem incluir o caractere nulo de terminação. Esse parâmetro será uma cadeia de caracteres vazia se não houver erros.

[in, out] pcchValueBuf

Ponteiro para a variável que especifica o tamanho, em TCHARs, do buffer apontado pela variável szValueBuf. Quando a função retorna ERROR_SUCCESS, essa variável contém o tamanho dos dados copiados para szValueBuf, sem incluir o caractere nulo de terminação. Se szValueBuf não for grande o suficiente, a função retornará ERROR_MORE_DATA e armazenará o tamanho necessário, sem incluir o caractere nulo de terminação, na variável apontada por pcchValueBuf.

Retornar valor

A função MsiSummaryInfoGetProperty retorna um dos seguintes valores:

Comentários

Se ERROR_MORE_DATA for retornado, o parâmetro que é um ponteiro fornecerá o tamanho do buffer necessário para manter a cadeia de caracteres. Se ERROR_SUCCESS for retornado, ele fornecerá o número de caracteres gravados no buffer de cadeia de caracteres. Portanto, você pode obter o tamanho do buffer passando uma cadeia de caracteres vazia (por exemplo, "") para o parâmetro que especifica o buffer. Não tente determinar o tamanho do buffer passando um Null (value=0).

As funções do Windows Installer que retornam dados em um local de memória fornecido pelo usuário não devem ser chamadas com nulo como o valor do ponteiro. Essas funções retornam uma cadeia de caracteres ou retornam dados como ponteiros inteiros, mas retornam valores inconsistentes ao passar nulo como o valor para o argumento de saída. Para obter mais informações, consulte Passando Null como o argumento das funções do Windows Installer.

As informações de propriedade retornadas pela função MsiSummaryInfoGetProperty são recebidas pelo parâmetro piValue, pftValue ou szValueBuf , dependendo do tipo de valor da propriedade especificado no parâmetro puiDataType .

Observação

O cabeçalho msiquery.h define MsiSummaryInfoGetProperty como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do 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
Plataforma de Destino	Windows
Cabeçalho	msiquery.h
Biblioteca	Msi.lib
DLL	Msi.dll

Confira também

Passando Null como o argumento das funções do Windows Installer

Funções de propriedade de informações de resumo

Conjunto de propriedades de fluxo de informações de resumo

Summaryinfo.Property