Função MsiSummaryInfoGetPropertyA (msiquery.h)

Artigo
11/20/2024

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

Observação O significado do valor da propriedade depende se o fluxo de informações de resumo é para um banco de dados de instalação (.msi arquivo), transformação (arquivo.mst) ou patch (arquivo .msp). Consulte descrições de propriedades de resumo e conjunto de propriedades de fluxo de informações resumo para obter mais informações sobre as propriedades de informações resumidas.

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

Lidar com 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 de fluxo de 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
conjunto de propriedades de fluxo de informações de resumo.

[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 nulo da propriedade de informações resumidas encerradas. Não tente determinar o tamanho do buffer passando um valor nulo (valor=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, não incluindo o caractere nulo de terminação. No retorno de ERROR_SUCCESS, pcchValueBuf contém o número de TCHARs gravados no buffer, não incluindo 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, não incluindo o caractere nulo de encerramento, na variável apontada por pcchValueBuf.

Valor de retorno

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

Observações

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 Nulo (valor=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 do argumento de saída. Para obter mais informações, consulte Passando nulo 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, pftValueou szValueBuf, dependendo do tipo de valor de propriedade especificado no parâmetro puiDataType .

Nota

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. 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
da Plataforma de Destino	Windows
cabeçalho	msiquery.h
biblioteca	Msi.lib
de DLL	Msi.dll

Consulte também

passando nulo como o argumento do Windows Installer Functions

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

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

Summaryinfo.Property

Compartilhar via