MsiGetSummaryInformationA, fonction (msiquery.h)

Article
11/20/2024

La fonction MsiGetSummaryInformation obtient un handle vers le flux de _SummaryInformation pour une base de données 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érer 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 de retour

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 de uiUpdateCount supérieure à 0 est utilisée pour ouvrir un flux d’informations récapitulative existant, msiSummaryInfoPersist doit être appelée avant de fermer le handle phSummaryInfo. L’échec de cette opération perd les informations de flux existantes.

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 vers le correctif à l’aide de msiOpenDatabase, puis passer ce handle à MsiGetSummaryInformation comme paramètre hDatabase.

Notez qu’il est recommandé d’utiliser des variables de type PMSIHANDLE, car le programme d’installation ferme les objets PMSIHANDLE à mesure qu’ils sortent de l’étendue, alors que vous devez fermer des objets MSIHANDLE en appelant MsiCloseHandle. Pour plus d’informations, consultez Utiliser PMSIHANDLE au lieu de la section HANDLE dans les meilleures pratiques Windows Installer.

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

Note

L’en-tête msiquery.h définit MsiGetSummaryInformation comme 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. Le mélange 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.

Exigences

Exigence	Valeur
client minimum 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
d’en-tête	msiquery.h
bibliothèque	Msi.lib
DLL	Msi.dll

Voir aussi

fonctions de propriétés d’informations récapitulatives

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

Partager via