MsiEnumComponentQualifiersA, fonction (msi.h)
La fonction MsiEnumComponentQualifiers énumère les qualificateurs publiés pour le composant donné. Cette fonction récupère un qualificateur chaque fois qu’elle est appelée.
Syntaxe
UINT MsiEnumComponentQualifiersA(
[in] LPCSTR szComponent,
[in] DWORD iIndex,
[out] LPSTR lpQualifierBuf,
[in, out] LPDWORD pcchQualifierBuf,
[out] LPSTR lpApplicationDataBuf,
[in, out] LPDWORD pcchApplicationDataBuf
);
Paramètres
[in] szComponent
Spécifie le composant dont les qualificateurs doivent être énumérés.
[in] iIndex
Spécifie l’index du qualificateur à récupérer. Ce paramètre doit être égal à zéro pour le premier appel à la fonction MsiEnumComponentQualifiers , puis incrémenté pour les appels suivants. Étant donné que les qualificateurs ne sont pas triés, tout nouveau qualificateur a un index arbitraire. Cela signifie que la fonction peut retourner des qualificateurs dans n’importe quel ordre.
[out] lpQualifierBuf
Pointeur vers une mémoire tampon qui reçoit le code de qualificateur.
[in, out] pcchQualifierBuf
Pointeur vers une variable qui spécifie la taille, en caractères, de la mémoire tampon vers laquelle pointe le paramètre lpQualifierBuf . Lors de l’entrée, cette taille doit inclure le caractère null de fin. En retour, la valeur n’inclut pas le caractère null.
[out] lpApplicationDataBuf
Pointeur vers une mémoire tampon qui reçoit les données inscrites de l’application pour le qualificateur. Ce paramètre peut avoir la valeur Null.
[in, out] pcchApplicationDataBuf
Pointeur vers une variable qui spécifie la taille, en caractères, de la mémoire tampon vers laquelle pointe le paramètre lpApplicationDataBuf . Lors de l’entrée, cette taille doit inclure le caractère null de fin. En retour, la valeur n’inclut pas le caractère null. Ce paramètre ne peut être null que si le paramètre lpApplicationDataBuf a la valeur null.
Valeur retournée
| Valeur | Signification |
|---|---|
|
Les données de configuration sont endommagées. |
|
Un paramètre non valide a été transmis à la fonction. |
|
Une mémoire tampon est trop petite pour contenir les données demandées. |
|
Il n’y a pas de qualificateurs à retourner. |
|
Le système ne dispose pas de suffisamment de mémoire pour terminer l’opération. Disponible avec Windows Server 2003. |
|
Une valeur a été énumérée. |
|
Le composant spécifié est inconnu. |
Notes
Pour énumérer les qualificateurs, une application doit initialement appeler la fonction MsiEnumComponentQualifiers avec le paramètre iIndex défini sur zéro. L’application doit ensuite incrémenter le paramètre iIndex et appeler MsiEnumComponentQualifiers jusqu’à ce qu’il n’y ait plus de qualificateurs (autrement dit, jusqu’à ce que la fonction retourne ERROR_NO_MORE_ITEMS).
Lorsque MsiEnumComponentQualifiers retourne, le paramètre pcchQualifierBuf contient la longueur de la chaîne de qualificateur stockée dans la mémoire tampon. Le nombre retourné n’inclut pas le caractère null de fin. Si la mémoire tampon n’est pas assez grande, MsiEnumComponentQualifiers retourne ERROR_MORE_DATA, et ce paramètre contient la taille de la chaîne, en caractères, sans compter le caractère null. Le même mécanisme s’applique à pcchDescriptionBuf.
Lorsque vous effectuez plusieurs appels à MsiEnumComponentQualifiers pour énumérer tous les qualificateurs publiés du composant, chaque appel doit être effectué à partir du même thread.
Notes
L’en-tête msi.h définit MsiEnumComponentQualifiers comme un 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.
Spécifications
| 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 |