MsiEnumRelatedProductsW, fonction (msi.h)

Article
11/20/2024

La fonction MsiEnumRelatedProducts énumère les produits avec un code de mise à niveau spécifié. Cette fonction répertorie les produits actuellement installés et publiés qui ont la propriété UpgradeCode spécifiée dans leur table de propriétés .

Syntaxe

UINT MsiEnumRelatedProductsW(
  [in]  LPCWSTR lpUpgradeCode,
  [in]  DWORD   dwReserved,
  [in]  DWORD   iProductIndex,
  [out] LPWSTR  lpProductBuf
);

Paramètres

[in] lpUpgradeCode

Chaîne terminée par null spécifiant le code de mise à niveau des produits associés que le programme d’installation doit énumérer.

[in] dwReserved

Ce paramètre est réservé et doit être 0.

[in] iProductIndex

Index de base zéro dans les produits inscrits.

[out] lpProductBuf

Mémoire tampon pour recevoir le GUID du code de produit. Cette mémoire tampon doit comporter 39 caractères. Les 38 premiers caractères concernent le GUID , et le dernier caractère correspond au caractère null de fin.

Valeur de retour

Valeur	Signification
ERROR_BAD_CONFIGURATION	Les données de configuration sont endommagées.
ERROR_INVALID_PARAMETER	Un paramètre non valide a été passé à la fonction.
ERROR_NO_MORE_ITEMS	Il n’y a aucun produit à retourner.
ERROR_NOT_ENOUGH_MEMORY	Le système n’a pas suffisamment de mémoire pour terminer l’opération. Disponible à partir de Windows Server 2003.
ERROR_SUCCESS	Une valeur a été énumérée.

Remarques

Consultez propriété UpgradeCode.

Pour énumérer les produits actuellement installés et publiés qui ont un code de mise à niveau spécifique, une application doit appeler initialement la fonction MsiEnumRelatedProducts avec le paramètre iProductIndex défini sur zéro. L’application doit ensuite incrémenter le paramètre iProductIndex et appeler MsiEnumRelatedProducts jusqu’à ce que la fonction retourne ERROR_NO_MORE_ITEMS, ce qui signifie qu’il n’y a plus de produits avec le code de mise à niveau spécifié.

Lorsque vous effectuez plusieurs appels à MsiEnumRelatedProducts pour énumérer tous les produits associés, chaque appel doit être effectué à partir du même thread.

Note

L’en-tête msi.h définit MsiEnumRelatedProducts 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. Consultez la configuration requise de Windows Installer Run-Time pour plus d’informations sur le service pack Windows minimal requis par une version de Windows Installer.
plateforme cible	Windows
d’en-tête	msi.h
bibliothèque	Msi.lib
DLL	Msi.dll

Partager via