Função MsiSummaryInfoGetPropertyA (msiquery.h)

A função MsiSummaryInfoGetProperty obtém uma única propriedade do fluxo 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 .

Requisitos

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