MsiSummaryInfoGetPropertyA, fonction (msiquery.h)
La fonction MsiSummaryInfoGetProperty obtient une seule propriété à partir du flux d’informations récapitulatives.
Syntaxe
UINT MsiSummaryInfoGetPropertyA(
[in] MSIHANDLE hSummaryInfo,
[in] UINT uiProperty,
[out] PUINT puiDataType,
[out] LPINT piValue,
[out] FILETIME *pftValue,
[out] LPSTR szValueBuf,
[in, out] LPDWORD pcchValueBuf
);
Paramètres
[in] hSummaryInfo
Gérer les informations récapitulatives.
[in] uiProperty
Spécifie l’ID de propriété de la propriété summary. Ce paramètre peut être un ID de propriété répertorié dans l’ensemble d’informations récapitulatives Stream de propriétés. Cette fonction ne retourne pas de valeurs pour PID_DICTIONARY propriété OR PID_THUMBNAIL.
[out] puiDataType
Reçoit le type de propriété retourné. Ce paramètre peut être un type répertorié dans le
Informations récapitulatives Stream jeu de propriétés.
[out] piValue
Reçoit les données de propriété entière retournées.
[out] pftValue
Pointeur vers une valeur de fichier.
[out] szValueBuf
Pointeur vers la mémoire tampon qui reçoit la valeur de propriété informations de résumé terminées par null. N’essayez pas de déterminer la taille de la mémoire tampon en transmettant une valeur null (valeur=0) pour szValueBuf. Vous pouvez obtenir la taille de la mémoire tampon en passant une chaîne vide (par exemple « »). La fonction retourne ensuite ERROR_MORE_DATA et pcchValueBuf contient la taille de mémoire tampon requise dans les TCHAR, sans inclure le caractère null de fin. Au retour de ERROR_SUCCESS, pcchValueBuf contient le nombre de TCHAR écrits dans la mémoire tampon, sans inclure le caractère null de fin. Ce paramètre est une chaîne vide en l’absence d’erreurs.
[in, out] pcchValueBuf
Pointeur vers la variable qui spécifie la taille, en TCHAR, de la mémoire tampon pointée par la variable szValueBuf. Lorsque la fonction retourne ERROR_SUCCESS, cette variable contient la taille des données copiées dans szValueBuf, sans inclure le caractère null de fin. Si szValueBuf n’est pas assez grand, la fonction retourne ERROR_MORE_DATA et stocke la taille requise, sans inclure le caractère null de fin, dans la variable pointée par pcchValueBuf.
Valeur retournée
La fonction MsiSummaryInfoGetProperty retourne l’une des valeurs suivantes :
Remarques
Si ERROR_MORE_DATA est retourné, le paramètre qui est un pointeur donne la taille de la mémoire tampon nécessaire pour contenir la chaîne. Si ERROR_SUCCESS est retourné, il indique le nombre de caractères écrits dans la mémoire tampon de chaîne. Par conséquent, vous pouvez obtenir la taille de la mémoire tampon en transmettant une chaîne vide (par exemple « ») pour le paramètre qui spécifie la mémoire tampon. N’essayez pas de déterminer la taille de la mémoire tampon en transmettant une valeur Null (valeur=0).
Les fonctions Windows Installer qui retournent des données dans un emplacement de mémoire fourni par l’utilisateur ne doivent pas être appelées avec null comme valeur pour le pointeur. Ces fonctions retournent une chaîne ou retournent des données sous forme de pointeurs entiers, mais retournent des valeurs incohérentes lors de l’utilisation d’une valeur nulle pour l’argument de sortie. Pour plus d’informations, consultez Passage de null en tant qu’argument des fonctions Windows Installer.
Les informations de propriété retournées par la fonction MsiSummaryInfoGetProperty sont reçues par le paramètre piValue, pftValue ou szValueBuf en fonction du type de valeur de propriété qui a été spécifié dans le paramètre puiDataType .
Notes
L’en-tête msiquery.h définit MsiSummaryInfoGetProperty 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
Passage de Null en tant qu’argument des fonctions Windows Installer
Fonctions de propriété d’informations de résumé
Ensemble de propriétés de flux d’informations récapitulatives