MsiProvideQualifiedComponentExA, fonction (msi.h)

Article
03/06/2024

La fonction MsiProvideQualifiedComponentEx retourne le chemin d’accès complet d’un composant qualifié publié par un produit et effectue toute installation nécessaire. Cette fonction demande la source si nécessaire et incrémente le nombre d’utilisations pour la fonctionnalité.

Syntaxe

UINT MsiProvideQualifiedComponentExA(
  [in]      LPCSTR  szCategory,
  [in]      LPCSTR  szQualifier,
  [in]      DWORD   dwInstallMode,
  [in]      LPCSTR  szProduct,
  [in]      DWORD   dwUnused1,
  [in]      DWORD   dwUnused2,
  [out]     LPSTR   lpPathBuf,
  [in, out] LPDWORD pcchPathBuf
);

Paramètres

[in] szCategory

Spécifie l’ID de composant correspondant au composant demandé. Il peut ne pas s’agir du GUID du composant lui-même, mais plutôt d’un serveur qui fournit les fonctionnalités appropriées, comme dans la colonne ComponentId de la table PublishComponent.

[in] szQualifier

Spécifie un qualificateur dans une liste de composants publicitaires (à partir de la table PublishComponent).

[in] dwInstallMode

Définit le mode d’installation. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
INSTALLMODE_DEFAULT	Fournissez le composant et effectuez toute installation nécessaire pour fournir le composant. Si le fichier de clé d’un composant dans la fonctionnalité demandée, ou un parent de fonctionnalité, est manquant, réinstallez la fonctionnalité à l’aide de MsiReinstallFeature avec les bits d’indicateur suivants définis : REINSTALLMODE_FILEMISSING, REINSTALLMODE_FILEOLDERVERSION, REINSTALLMODE_FILEVERIFY, REINSTALLMODE_MACHINEDATA, REINSTALLMODE_USERDATA et REINSTALLMODE_SHORTCUT.
INSTALLMODE_EXISTING	Fournissez le composant uniquement si la fonctionnalité existe. Sinon, retournez ERROR_FILE_NOT_FOUND. Ce mode vérifie que le fichier de clé du composant existe.
INSTALLMODE_NODETECTION	Fournissez le composant uniquement si la fonctionnalité existe. Sinon, retournez ERROR_FILE_NOT_FOUND. Ce mode vérifie uniquement que le composant est inscrit et ne vérifie pas que le fichier de clé du composant existe.
INSTALLMODE_EXISTING	Fournissez le composant uniquement si la fonctionnalité existe ; sinon, retournez ERROR_FILE_NOT_FOUND.
combinaison des indicateurs REINSTALLMODE	Appelez MsiReinstallFeature pour réinstaller la fonctionnalité à l’aide de ce paramètre pour le paramètre dwReinstallMode , puis fournissez le composant.
INSTALLMODE_NOSOURCERESOLUTION	Fournissez le composant uniquement si l’état d’installation de la fonctionnalité est INSTALLSTATE_LOCAL. Si l’état d’installation de la fonctionnalité est INSTALLSTATE_SOURCE, retournez ERROR_INSTALL_SOURCE_ABSENT. Sinon, retournez ERROR_FILE_NOT_FOUND. Ce mode vérifie uniquement que le composant est inscrit et ne vérifie pas que le fichier de clé existe.

[in] szProduct

Spécifie le produit à mettre en correspondance qui a publié le composant qualifié. Si cette valeur est null, cette API fonctionne de la même façon que MsiProvideQualifiedComponent.

[in] dwUnused1

Réservé. Doit être zéro.

[in] dwUnused2

Réservé. Doit être zéro.

[out] lpPathBuf

Pointeur vers une variable qui reçoit le chemin d’accès au composant. Ce paramètre peut avoir la valeur Null.

[in, out] pcchPathBuf

Pointeur vers une variable qui spécifie la taille, en caractères, de la mémoire tampon vers laquelle pointe le paramètre lpPathBuf . Lors de l’entrée, il s’agit de la taille complète de la mémoire tampon, y compris un espace pour un caractère null de fin. Si la mémoire tampon passée est trop petite, le nombre retourné n’inclut pas le caractère null de fin.

Si lpPathBuf a la valeur null, pcchBuf peut être null.

Valeur retournée

Valeur	Signification
ERROR_INDEX_ABSENT	Le qualificateur de composant n’est pas valide ou n’est pas présent.
ERROR_SUCCESS	La fonction s’est terminée avec succès.
ERROR_FILE_NOT_FOUND	La fonctionnalité est absente ou interrompue. cette erreur est retournée pour dwInstallMode = INSTALLMODE_EXISTING.
ERROR_UNKNOWN_COMPONENT	Le composant spécifié est inconnu.
Erreur liée à une action	Consultez Codes d’erreur.
Erreur d’initialisation	Une erreur relative à l’initialisation s’est produite.

Remarques

En cas de réussite de la fonction MsiProvideQualifiedComponentEx , le paramètre pcchPathBuf contient la longueur de la chaîne dans lpPathBuf.

Les fonctionnalités avec des composants contenant un fichier endommagé ou une version incorrecte d’un fichier doivent être réinstallées explicitement par l’utilisateur ou en demandant à l’application d’appeler MsiReinstallFeature.

Notes

L’en-tête msi.h définit MsiProvideQualifiedComponentEx 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. Pour plus d’informations sur le Service Pack Windows requis par une version de Windows Installer, consultez Configuration requise pour le runtime Windows.
Plateforme cible	Windows
En-tête	msi.h
Bibliothèque	Msi.lib
DLL	Msi.dll