MsiGetSummaryInformationA, fonction (msiquery.h)

  • Article

La fonction MsiGetSummaryInformation obtient un handle dans le flux _SummaryInformation pour une base de données du programme d’installation. Cette fonction retourne un handle qui doit être fermé à l’aide de MsiCloseHandle.

Syntaxe

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

Paramètres

[in] hDatabase

Gérez la base de données.

[in] szDatabasePath

Spécifie le chemin d’accès à la base de données.

[in] uiUpdateCount

Spécifie le nombre maximal de valeurs mises à jour.

[out] phSummaryInfo

Pointeur vers l’emplacement à partir duquel recevoir le handle d’informations récapitulatives.

Valeur retournée

La fonction MsiGetSummaryInformation retourne les valeurs suivantes :

Remarques

Si la base de données spécifiée par la fonction MsiGetSummaryInformation n’est pas ouverte, vous devez spécifier 0 pour hDatabase et spécifier le chemin d’accès à la base de données dans szDatabasePath. Si la base de données est ouverte, vous devez définir szDatabasePath sur 0.

Si une valeur uiUpdateCount supérieure à 0 est utilisée pour ouvrir un flux d’informations récapitulatives existant, MsiSummaryInfoPersist doit être appelé avant de fermer le handle phSummaryInfo . Dans le cas contraire, les informations de flux existantes seront perdues.

Pour afficher les informations récapitulatives d’un correctif à l’aide de MsiGetSummaryInformation, définissez szDatabasePath sur le chemin du correctif. Vous pouvez également créer un handle pour le correctif à l’aide de MsiOpenDatabase , puis le transmettre à MsiGetSummaryInformation en tant que paramètre hDatabase .

Notez qu’il est recommandé d’utiliser des variables de type PMSIHANDLE, car le programme d’installation ferme les objets PMSIHANDLE en dehors de leur portée, tandis que vous devez fermer les objets MSIHANDLE en appelant MsiCloseHandle. Pour plus d’informations, consultez la section Utiliser PMSIHANDLE au lieu de HANDLE dans les Bonnes pratiques de Windows Installer.

Si la fonction échoue, vous pouvez obtenir des informations d’erreur étendues à l’aide de MsiGetLastErrorRecord.

Notes

L’en-tête msiquery.h définit MsiGetSummaryInformation en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Installer 5.0 sur Windows Server 2012, Windows 8, Windows Server 2008 R2 ou Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 sur Windows Server 2008 ou Windows Vista. Windows Installer sur Windows Server 2003 ou Windows XP
Plateforme cible Windows
En-tête msiquery.h
Bibliothèque Msi.lib
DLL Msi.dll

Voir aussi

Fonctions de propriété d’informations de résumé

Ensemble de propriétés de flux d’informations récapitulatives