MsiExtractPatchXMLDataA, fonction (msi.h)

  • Article

La fonction MsiExtractPatchXMLData extrait des informations d’un correctif qui peuvent être utilisées pour déterminer si le correctif s’applique à un système cible. La fonction retourne une chaîne XML qui peut être fournie à MsiDeterminePatchSequence et MsiDetermineApplicablePatches au lieu du fichier patch complet. Les informations retournées peuvent être utilisées pour déterminer si le correctif est applicable.

Syntaxe

UINT MsiExtractPatchXMLDataA(
  [in]                LPCSTR  szPatchPath,
  [in]                DWORD   dwReserved,
  [out, optional]     LPSTR   szXMLData,
  [in, out, optional] LPDWORD pcchXMLData
);

Paramètres

[in] szPatchPath

Chemin d’accès complet au correctif interrogé. Passez en tant que chaîne terminée par null. Ce paramètre ne peut pas être NULL.

[in] dwReserved

Argument réservé qui doit être égal à 0 (zéro).

[out, optional] szXMLData

Pointeur vers une mémoire tampon pour contenir la chaîne XML qui contient les informations de correctif extraites. Cette mémoire tampon doit être suffisamment grande pour contenir les informations reçues. Si la mémoire tampon est trop petite, la fonction retourne ERROR_MORE_DATA et définit *pcchXMLData sur le nombre de TCHAR dans la valeur, sans inclure le caractère NULL de fin.

Si szXMLData a la valeur NULL et que pcchXMLData est défini sur un pointeur valide, la fonction retourne ERROR_SUCCESS et définit *pcchXMLData sur le nombre de TCHAR dans la valeur, sans inclure le caractère NULL de fin. La fonction peut ensuite être appelée à nouveau pour récupérer la valeur, avec la mémoire tampon szXMLData suffisamment grande pour contenir *pcchXMLData + 1 caractères.

[in, out, optional] pcchXMLData

Pointeur vers une variable qui spécifie le nombre de TCHAR dans la mémoire tampon szXMLData . Lorsque la fonction retourne, ce paramètre est défini sur la taille de la valeur demandée, que la fonction copie ou non la valeur dans la mémoire tampon spécifiée. La taille est retournée en tant que nombre de TCHAR dans la valeur demandée, sans inclure le caractère null de fin.

Si ce paramètre est défini sur NULL, la fonction retourne ERROR_INVALID_PARAMETER.

Valeur retournée

La fonction MsiExtractPatchXMLData peut retourner les valeurs suivantes.

Code de retour Description
ERROR_FUNCTION_FAILED
 La fonction a échoué d’une manière qui n’est identifiée par aucune des valeurs de retour dans cette table.
ERROR_INVALID_PARAMETER
 Un paramètre non valide a été transmis à la fonction.
ERROR_MORE_DATA
 La valeur ne tient pas dans la mémoire tampon fournie.
ERROR_PATCH_OPEN_FAILED
 Impossible d’ouvrir le fichier correctif.
ERROR_SUCCESS
 La fonction a réussi.
ERROR_PATCH_PACKAGE_INVALID
 Impossible d’ouvrir le fichier correctif.
ERROR_CALL_NOT_IMPLEMENTED
 Cette erreur peut être retournée si MSXML 3.0 n’est pas installé.

Remarques

La méthode ExtractPatchXMLData de l’objet Installer utilise la fonction MsiExtractPatchXMLData .

Notes

L’en-tête msi.h définit MsiExtractPatchXMLData 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. 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 4.0 ou Windows Installer 4.5 sur Windows Server 2008 ou Windows Vista. Windows Installer 3.0 ou version ultérieure 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

Voir aussi

MsiDetermineApplicablePatches

MsiDeterminePatchSequence

Non pris en charge par Windows Installer 2.0 et antérieur