MsiEnumClientsW, fonction (msi.h)

Article
11/20/2024

La fonction MsiEnumClients énumère les clients pour un composant installé donné. La fonction récupère un code de produit chaque fois qu’il est appelé.

Syntaxe

UINT MsiEnumClientsW(
  [in]  LPCWSTR szComponent,
  [in]  DWORD   iProductIndex,
  [out] LPWSTR  lpProductBuf
);

Paramètres

[in] szComponent

Spécifie le composant dont les clients doivent être énumérés.

[in] iProductIndex

Spécifie l’index du client à récupérer. Ce paramètre doit être égal à zéro pour le premier appel à la fonction MsiEnumClients, puis incrémenté pour les appels suivants. Étant donné que les clients ne sont pas ordonnés, tout nouveau client a un index arbitraire. Cela signifie que la fonction peut retourner des clients 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
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 client à retourner.
ERROR_NOT_ENOUGH_MEMORY	Le système n’a pas suffisamment de mémoire pour terminer l’opération. Disponible avec Windows Server 2003.
ERROR_SUCCESS	Une valeur a été énumérée.
ERROR_UNKNOWN_COMPONENT	Le composant spécifié est inconnu.

Remarques

Pour énumérer les clients, une application doit appeler initialement la fonction MsiEnumClients avec le paramètre iProductIndex défini sur zéro. L’application doit ensuite incrémenter le paramètre iProductIndex et appeler MsiEnumClients jusqu’à ce qu’il n’y ait plus de clients (autrement dit, jusqu’à ce que la fonction retourne ERROR_NO_MORE_ITEMS).

Lorsque vous effectuez plusieurs appels à MsiEnumClients pour énumérer tous les clients du composant, chaque appel doit être effectué à partir du même thread.

Note

L’en-tête msi.h définit MsiEnumClients 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

Voir aussi

fonctions d’état système

Partager via