Fonction SetupLogFileW (setupapi.h)

Article
03/01/2024

[Cette fonction est disponible pour une utilisation 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 l’installation d’applications. Utilisez plutôt Windows Installer pour développer des programmes d’installation d’applications. SetupAPI continue d’être utilisé pour l’installation des pilotes de périphérique.]

La fonction SetupLogFile ajoute une entrée au fichier journal.

Syntaxe

WINSETUPAPI BOOL SetupLogFileW(
  [in] HSPFILELOG FileLogHandle,
  [in] PCWSTR     LogSectionName,
  [in] PCWSTR     SourceFilename,
  [in] PCWSTR     TargetFilename,
  [in] DWORD      Checksum,
  [in] PCWSTR     DiskTagfile,
  [in] PCWSTR     DiskDescription,
  [in] PCWSTR     OtherInfo,
  [in] DWORD      Flags
);

Paramètres

[in] FileLogHandle

Gérez le fichier journal comme retourné par SetupInitializeFileLog. L’appelant ne doit pas avoir passé SPFILELOG_QUERYONLY lorsque le fichier journal a été initialisé.

[in] LogSectionName

Pointeur facultatif vers le nom d’un regroupement logique de noms dans le fichier journal. Vous devez utiliser une chaîne terminée par null. Obligatoire si SPFILELOG_SYSTEMLOG n’a pas été transmis lors de l’initialisation du journal des fichiers. Sinon, ce paramètre peut avoir la valeur NULL.

[in] SourceFilename

Nom du fichier tel qu’il existe sur le support source à partir duquel il a été installé. Ce nom doit être dans n’importe quel format significatif pour l’appelant. Vous devez utiliser une chaîne terminée par null.

[in] TargetFilename

Nom du fichier tel qu’il existe sur la cible. Ce nom doit être dans n’importe quel format significatif pour l’appelant. Vous devez utiliser une chaîne terminée par null.

[in] Checksum

Pointeur facultatif vers une valeur de somme de contrôle. Obligatoire pour le journal système.

[in] DiskTagfile

Pointeur facultatif vers le tagfile du média à partir duquel le fichier a été installé. Vous devez utiliser une chaîne terminée par null. La chaîne terminée par null ne doit pas dépasser la taille de la mémoire tampon de destination. Ignoré pour le journal système si SPFILELOG_OEMFILE n’est pas spécifié. Obligatoire pour le journal système si SPFILELOG_OEMFILE est spécifié. Sinon, ce paramètre peut avoir la valeur NULL.

[in] DiskDescription

Pointeur facultatif vers la description lisible par l’utilisateur du média à partir duquel le fichier a été installé. Vous devez utiliser une chaîne terminée par null. Ignoré pour le journal système si SPFILELOG_OEMFILE n’est pas spécifié dans le paramètre Flags . Obligatoire pour le journal système si SPFILELOG_OEMFILE est spécifié dans le paramètre Flags. Sinon, ce paramètre peut avoir la valeur NULL.

[in] OtherInfo

Pointeur facultatif vers des informations supplémentaires à associer au fichier. Vous devez utiliser une chaîne terminée par null. Ce paramètre peut être NULL.

[in] Flags

Ce paramètre peut être SPFILELOG_OEMFILE, ce qui est significatif uniquement pour le journal système et indique que le fichier n’est pas fourni par Microsoft. Ce paramètre peut être utilisé pour convertir l’entrée d’un fichier existant, par exemple lorsqu’un oem remplace un fichier système fourni par Microsoft.

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

Notes

L’en-tête setupapi.h définit SetupLogFile comme un 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.

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

SetupRemoveFileLogEntry

Partager via