MsiEnumProductsA, fonction (msi.h)
La fonction MsiEnumProducts énumère tous les produits actuellement publiés ou installés. Les produits installés dans le contexte d’installation par utilisateur et par ordinateur contexte d’installation et les publicités sont énumérés.
Syntaxe
UINT MsiEnumProductsA(
[in] DWORD iProductIndex,
[out] LPSTR lpProductBuf
);
Paramètres
[in] iProductIndex
Spécifie l’index du produit à récupérer. Ce paramètre doit être égal à zéro pour le premier appel à la fonction MsiEnumProducts, puis incrémenté pour les appels suivants. Étant donné que les produits ne sont pas commandés, tout nouveau produit a un index arbitraire. Cela signifie que la fonction peut retourner des produits dans n’importe quel ordre.
[out] lpProductBuf
Pointeur vers une mémoire tampon qui reçoit le code du 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 |
|---|---|
|
Les données de configuration sont endommagées. |
|
Un paramètre non valide a été passé à la fonction. |
|
Il n’y a aucun produit à retourner. |
|
Le système n’a pas suffisamment de mémoire pour terminer l’opération. Disponible avec Windows Server 2003. |
|
Une valeur a été énumérée. |
Remarques
Pour énumérer les produits, une application doit initialement appeler la fonction MsiEnumProducts avec le paramètre iProductIndex défini sur zéro. L’application doit ensuite incrémenter le paramètre iProductIndex et appeler MsiEnumProducts jusqu’à ce qu’il n’y ait plus de produits (jusqu’à ce que la fonction retourne ERROR_NO_MORE_ITEMS).
Lorsque vous effectuez plusieurs appels à MsiEnumProducts pour énumérer tous les produits, chaque appel doit être effectué à partir du même thread.
Note
L’en-tête msi.h définit MsiEnumProducts 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 |