MsiGetComponentStateA, fonction (msiquery.h)

La fonction MsiGetComponentState obtient l’état d’un composant.

Syntaxe

UINT MsiGetComponentStateA(
  [in]  MSIHANDLE    hInstall,
  [in]  LPCSTR       szComponent,
  [out] INSTALLSTATE *piInstalled,
  [out] INSTALLSTATE *piAction
);

Paramètres

[in] hInstall

Gérez l’installation fournie à une action personnalisée DLL ou obtenue via MsiOpenPackage, MsiOpenPackageEx ou MsiOpenProduct.

[in] szComponent

Chaîne terminée par null qui spécifie le nom du composant dans le produit.

[out] piInstalled

Reçoit l’état installé actuel. Ce paramètre ne doit pas être null. Ce paramètre peut prendre les valeurs suivantes.

Valeur Signification
INSTALLSTATE_ABSENT
Le composant n’est pas installé.
INSTALLSTATE_DEFAULT
Le composant est installé à l’emplacement par défaut : local ou source.
INSTALLSTATE_LOCAL
Le composant est installé sur le lecteur local.
INSTALLSTATE_REMOVED
Le composant est en cours de suppression. État action et non paramétrable.
INSTALLSTATE_SOURCE
Le composant s’exécute à partir de la source, du CD-ROM ou du réseau.
INSTALLSTATE_UNKNOWN
Un nom de produit ou de fonctionnalité non reconnu a été passé à la fonction.

[out] piAction

Reçoit l’action effectuée lors de l’installation. Ce paramètre ne doit pas être null. Pour les valeurs de retour, consultez piInstalled.

Valeur retournée

La fonction MsiGetComponentState retourne les valeurs suivantes :

Remarques

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

Pour plus d’informations, consultez Appel de fonctions de base de données à partir de programmes.

Notes

L’en-tête msiquery.h définit MsiGetComponentState 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. 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 sélection du programme d’installation

Passage de Null en tant qu’argument des fonctions Windows Installer