MsiGetPatchInfoA, fonction (msi.h)

La fonction MsiGetPatchInfo retourne des informations sur un correctif.

Syntaxe

UINT MsiGetPatchInfoA(
  [in]      LPCSTR  szPatch,
  [in]      LPCSTR  szAttribute,
  [out]     LPSTR   lpValueBuf,
  [in, out] LPDWORD pcchValueBuf
);

Paramètres

[in] szPatch

Spécifie le code de correctif pour le package de correctifs.

[in] szAttribute

Spécifie l’attribut à récupérer.

Attribut Signification
INSTALLPROPERTY_LOCALPACKAGE
Package mis en cache local.

[out] lpValueBuf

Pointeur vers une mémoire tampon qui reçoit la valeur de la propriété. Ce paramètre peut être null.

[in, out] pcchValueBuf

Pointeur vers une variable qui spécifie la taille, en caractères, de la mémoire tampon pointée par le paramètre lpValueBuf. 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 lpValueBuf a la valeur Null, pcchValueBuf peut être null.

Valeur de retour

La fonction MsiGetPatchInfo retourne les valeurs suivantes.

Valeur Signification
ERROR_BAD_CONFIGURATION
Les données de configuration sont endommagées.
ERROR_INVALID_PARAMETER
Un paramètre non valide a été passé à la fonction.
ERROR_MORE_DATA
Une mémoire tampon est trop petite pour contenir les données demandées.
ERROR_SUCCESS
La fonction s’est terminée correctement.
ERROR_UNKNOWN_PRODUCT
Le package de correctifs n’est pas installé.
ERROR_UNKNOWN_PROPERTY
La propriété n’est pas reconnue.
 
 

Remarques

Lorsque la fonction MsiGetPatchInfo retourne, le paramètre pcchValueBuf contient la longueur de la chaîne de classe stockée dans la mémoire tampon. Le nombre retourné n’inclut pas le caractère null de fin.

Si la mémoire tampon est trop petite pour contenir les données demandées, MsiGetPatchInfo retourne ERROR_MORE_DATA et pcchValueBuf contient le nombre de caractères copiés dans lpValueBuf, sans compter le caractère null.

Note

L’en-tête msi.h définit MsiGetPatchInfo 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. 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. Consultez la configuration requise de Windows Installer Run-Time pour plus d’informations sur le service pack Windows minimal requis par une version de Windows Installer.
plateforme cible Windows
d’en-tête msi.h
bibliothèque Msi.lib
DLL Msi.dll

Voir aussi

non pris en charge dans Windows Installer 2.0 et versions antérieures