Função MsiGetSummaryInformationA (msiquery.h)

Artigo
11/20/2024

A função MsiGetSummaryInformation obtém um identificador para o fluxo de _SummaryInformation para um banco de dados do instalador. Essa função retorna um identificador que deve ser fechado usando MsiCloseHandle.

Sintaxe

UINT MsiGetSummaryInformationA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szDatabasePath,
  [in]  UINT      uiUpdateCount,
  [out] MSIHANDLE *phSummaryInfo
);

Parâmetros

[in] hDatabase

Manipule para o banco de dados.

[in] szDatabasePath

Especifica o caminho para o banco de dados.

[in] uiUpdateCount

Especifica o número máximo de valores atualizados.

[out] phSummaryInfo

Ponteiro para o local do qual receber o identificador de informações de resumo.

Valor de retorno

A função MsiGetSummaryInformation retorna os seguintes valores:

Observações

Se o banco de dados especificado pela função MsiGetSummaryInformation não estiver aberto, você deverá especificar 0 para hDatabase e especificar o caminho para o banco de dados em szDatabasePath. Se o banco de dados estiver aberto, você deverá definir szDatabasePath como 0.

Se um valor de uiUpdateCount maior que 0 for usado para abrir um fluxo de informações de resumo existente, msiSummaryInfoPersist deverá ser chamado antes de fechar o identificador phSummaryInfo. A falha ao fazer isso perderá as informações de fluxo existentes.

Para exibir as informações resumidas de um patch usando MsiGetSummaryInformation, defina szDatabasePath para o caminho para o patch. Como alternativa, você pode criar um identificador para o patch usando MsiOpenDatabase e, em seguida, passar esse identificador para MsiGetSummaryInformation como o parâmetro hDatabase.

Observe que é recomendável usar variáveis do tipo PMSIHANDLE porque o instalador fecha objetos PMSIHANDLE à medida que eles saem do escopo, enquanto você deve fechar objetos MSIHANDLE chamando MsiCloseHandle. Para obter mais informações, consulte Usar PMSIHANDLE em vez da seção HANDLE node Práticas Recomendadas do Instalador do Windows .

Se a função falhar, você poderá obter informações de erro estendidas usando msiGetLastErrorRecord.

Nota

O cabeçalho msiquery.h define MsiGetSummaryInformation 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

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

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

Compartilhar via