Función MsiGetSummaryInformationA (msiquery.h)

La función MsiGetSummaryInformation obtiene un identificador de la secuencia de _SummaryInformation para una base de datos del instalador. Esta función devuelve un identificador que se debe cerrar mediante MsiCloseHandle.

Sintaxis

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

Parámetros

[in] hDatabase

Identificador de la base de datos.

[in] szDatabasePath

Especifica la ruta de acceso a la base de datos.

[in] uiUpdateCount

Especifica el número máximo de valores actualizados.

[out] phSummaryInfo

Puntero a la ubicación desde la que se va a recibir el identificador de información de resumen.

Valor devuelto

La función MsiGetSummaryInformation devuelve los siguientes valores:

Comentarios

Si la base de datos especificada por la función MsiGetSummaryInformation no está abierta, debe especificar 0 para hDatabase y especificar la ruta de acceso a la base de datos en szDatabasePath. Si la base de datos está abierta, debe establecer szDatabasePath en 0.

Si se usa un valor de uiUpdateCount mayor que 0 para abrir una secuencia de información de resumen existente, se debe llamar a MsiSummaryInfoPersist antes de cerrar el identificador phSummaryInfo . Si no lo hace, se perderá la información de flujo existente.

Para ver la información de resumen de una revisión mediante MsiGetSummaryInformation, establezca szDatabasePath en la ruta de acceso a la revisión. Como alternativa, puede crear un identificador para la revisión mediante MsiOpenDatabase y, a continuación, pasar ese identificador a MsiGetSummaryInformation como parámetro hDatabase .

Tenga en cuenta que se recomienda usar variables de tipo PMSIHANDLE porque el instalador cierra los objetos PMSIHANDLE a medida que salen del ámbito, mientras que debe cerrar objetos MSIHANDLE mediante una llamada a MsiCloseHandle. Para más información, consulte la sección Uso de PMSIHANDLE, en lugar de HANDLE en los procedimientos recomendados de Windows Installer.

Si se produce un error en la función, puede obtener información de error extendida mediante MsiGetLastErrorRecord.

Nota

El encabezado msiquery.h define MsiGetSummaryInformation como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Installer 5.0 en Windows Server 2012, Windows 8, Windows Server 2008 R2 o Windows 7. Windows Installer 4.0 o Windows Installer 4.5 en Windows Server 2008 o Windows Vista. Windows Installer en Windows Server 2003 o Windows XP
Plataforma de destino	Windows
Encabezado	msiquery.h
Library	Msi.lib
Archivo DLL	Msi.dll

Consulte también

Funciones de propiedad de información de resumen

Conjunto de propiedades de flujo de información de resumen