SetupQueryFileLogW, fonction (setupapi.h)

Article
03/06/2024

[Cette fonction peut être utilisée dans les systèmes d’exploitation indiqués dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. SetupAPI ne doit plus être utilisé pour installer des applications. Utilisez plutôt Windows Installer pour développer des programmes d’installation d’applications. SetupAPI continue d’être utilisé pour installer les pilotes de périphérique.]

La fonction SetupQueryFileLog retourne des informations à partir d’un journal de fichier d’installation.

Syntaxe

WINSETUPAPI BOOL SetupQueryFileLogW(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCWSTR           LogSectionName,
  [in]      PCWSTR           TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PWSTR            DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

Paramètres

[in] FileLogHandle

Gérez le journal des fichiers comme retourné par SetupInitializeFileLog.

[in] LogSectionName

Pointeur facultatif vers le nom de section du fichier journal dans un format significatif pour l’appelant. Vous devez utiliser une chaîne terminée par null. Obligatoire pour les journaux non système. Si aucun LogSectionName n’est spécifié pour un journal système, une valeur par défaut est fournie.

[in] TargetFilename

Nom du fichier pour lequel les informations de journal sont souhaitées. Vous devez utiliser une chaîne terminée par null.

[in] DesiredInfo

Indique quelles informations doivent être retournées à la mémoire tampon DataOut . Ce paramètre peut être l’une des valeurs énumérées suivantes.

Valeur	Signification
SetupFileLogSourceNom du fichier	Nom du fichier source tel qu’il existe sur le média source
SetupFileLogChecksum	Valeur de somme de contrôle utilisée par le journal système
SetupFileLogDiskTagfile	Nom du fichier d’étiquettes de la source multimédia contenant le fichier source
SetupFileLogDiskDescription	Description lisible par l’utilisateur du média où réside le fichier source
SetupFileLogOtherInfo	Informations supplémentaires associées au fichier journalisé

Si la valeur de DesiredInfo est supérieure à SetupFileLogOtherInfo , la fonction échoue et GetLastError retourne ERROR_INVALID_PARAMETER.

[in, out] DataOut

Pointeur facultatif vers une mémoire tampon dans laquelle cette fonction retourne les informations demandées pour le fichier. Vous devez utiliser une chaîne terminée par null. La chaîne terminée par un caractère Null ne doit pas dépasser la taille de la mémoire tampon de destination. Vous pouvez appeler la fonction une fois pour obtenir la taille de mémoire tampon requise, allouer la mémoire nécessaire, puis appeler la fonction une deuxième fois pour récupérer les données. Consultez la section Notes. À l’aide de cette technique, vous pouvez éviter les erreurs dues à une taille de mémoire tampon insuffisante. Toutes les informations ne sont pas fournies pour chaque fichier. Une erreur n’est pas retournée si une entrée vide pour le fichier existe dans le journal. Ce paramètre peut être NULL.

[in] ReturnBufferSize

Taille de la mémoire tampon DataOut , en caractères. Cela inclut la marque de fin null . Si la mémoire tampon est trop petite et que DataOut est spécifié, les données ne sont pas stockées dans la mémoire tampon et la fonction retourne zéro. Si DataOut n’est pas spécifié, le paramètre ReturnBufferSize est ignoré.

[in, out] RequiredSize

Pointeur facultatif vers une variable qui reçoit la taille requise de DataOut, en caractères. Ce nombre inclut la marque de fin Null .

Valeur retournée

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si cette fonction est appelée avec un DataOut de NULL et un ReturnBufferSize de zéro, la fonction place la taille de mémoire tampon nécessaire pour contenir les données spécifiées dans la variable pointée par RequiredSize. Si la fonction réussit dans ce cas, la valeur de retour est une valeur différente de zéro. Sinon, la valeur de retour est zéro et des informations d’erreur étendues peuvent être obtenues en appelant GetLastError.

Si la valeur de DesiredInfo est supérieure à SetupFileLogOtherInfo , la fonction échoue et GetLastError retourne ERROR_INVALID_PARAMETER.

Notes

L’en-tête setupapi.h définit SetupQueryFileLog 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 XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	setupapi.h
Bibliothèque	Setupapi.lib
DLL	Setupapi.dll

Voir aussi

Fonctions

Vue d'ensemble

SetupLogFile

Partager via