MsiGetSummaryInformation

[This is preliminary documentation and subject to change.]

The MsiGetSummaryInformation function obtains a handle to the _SummaryInformation stream for an installer database.

UINT MsiGetSummaryInformation(
  MSIHANDLE hDatabase,       // database handle
  LPCTSTR szDatabasePath,    // path to database
  UINT uiUpdateCount,        // maximum number of updated values, 0
                             // to open read-only
  MSIHANDLE *phSummaryInfo   // location to return summary information
                             // handle
);
 

Parameters

hDatabase

Handle to the database.

szDatabasePath

Specifies the path to the database.

uiUpdateCount

Specifies the maximum number of updated values.

phSummaryInfo

Pointer to the location from which to receive the summary information handle.

Return Values

ERROR_INSTALL_PACKAGE_INVALID

The installation package is invalid.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function.

ERROR_SUCCESS

The function succeeded.

Remarks

If the database specified by the MsiGetSummaryInformation function is not open, you must specify 0 for hDatabase and specify the path to the database in szDatabasePath. If the database is open, you must set szDatabasePath to 0.

QuickInfo

  Windows NT: Requires version 4.0 or later. Available as a redistributable for Windows NT 4.0.
  Windows: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in msiquery.h.
  Import Library: Use msi.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Database Access Reference, Summary Information Property Functions