Partager via


MsiSummaryInfoGetPropertyW, fonction (msiquery.h)

La fonction MsiSummaryInfoGetProperty obtient une propriété unique à partir du flux d’informations récapitulative .

Remarque La signification de la valeur de propriété dépend du flux d’informations récapitulative pour une base de données d’installation (fichier.msi), transformation (fichier.mst) ou patch (fichier .msp). Pour plus d’informations sur les propriétés récapitulatives, consultez Description des propriétés résumées et Ensemble de propriétés de flux d’informations de synthèse.
 

Syntaxe

UINT MsiSummaryInfoGetPropertyW(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPWSTR    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é récapitulative. Ce paramètre peut être un ID de propriété répertorié dans le jeu de propriétés de flux d’informations de synthèse . 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
ensemble de propriétés de flux d’informations récapitulatives.

[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é d’informations récapitulatives terminée par null. N’essayez pas de déterminer la taille de la mémoire tampon en transmettant une valeur Null (value=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 TCHARs, sans inclure le caractère null de fin. Lors du retour de ERROR_SUCCESS, pcchValueBuf contient le nombre de TCHAR écrites dans la mémoire tampon, sans inclure le caractère null de fin. Ce paramètre est une chaîne vide s’il n’y a aucune erreur.

[in, out] pcchValueBuf

Pointeur vers la variable qui spécifie la taille, dans TCHARs, 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 suffisamment volumineux, 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 de retour

La fonction MsiSummaryInfoGetProperty retourne l’une des valeurs suivantes :

Remarques

Si ERROR_MORE_DATA est retournée, le paramètre qui est un pointeur donne la taille de la mémoire tampon requise pour contenir la chaîne. Si ERROR_SUCCESS est retourné, il donne 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 passant une valeur Null (value=0).

Les fonctions Windows Installer qui retournent des données dans un emplacement 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 en tant que pointeurs entiers, mais retournent des valeurs incohérentes lors du passage de la valeur Null comme valeur pour l’argument de sortie. Pour plus d’informations, consultez Passage de la valeur Null en tant qu’argument des fonctions Windows Installer.

Les informations de propriété retournées par la fonction MsiSummaryInfoGetPropertyProper ty sont reçues par la fonction piValue, pftValueou paramètre szValueBuf en fonction du type de valeur de propriété spécifié dans le paramètre puiDataType.

Note

L’en-tête msiquery.h définit MsiSummaryInfoGetProperty en tant qu’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
plateforme cible Windows
d’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és d’informations récapitulatives

ensemble de propriétés de flux d’informations récapitulatives

Summaryinfo.Property