SetupLogFileA-Funktion (setupapi.h)

Artikel
11/20/2024

[Diese Funktion steht für die Verwendung in den im Abschnitt "Anforderungen" angegebenen Betriebssystemen zur Verfügung. Sie kann in nachfolgenden Versionen geändert oder nicht verfügbar sein. SetupAPI sollte nicht mehr für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin für die Installation von Gerätetreibern verwendet.]

Die SetupLogFile--Funktion fügt der Protokolldatei einen Eintrag hinzu.

Syntax

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

Parameter

[in] FileLogHandle

Behandeln Sie das Dateiprotokoll, wie von SetupInitializeFileLogzurückgegeben. Der Aufrufer darf nicht SPFILELOG_QUERYONLY übergeben haben, wenn die Protokolldatei initialisiert wurde.

[in] LogSectionName

Optionaler Zeiger auf den Namen für eine logische Gruppierung von Namen in der Protokolldatei. Sie sollten eine null--terminated-Zeichenfolge verwenden. Erforderlich, wenn SPFILELOG_SYSTEMLOG beim Initialisieren des Dateiprotokolls nicht übergeben wurde. Andernfalls kann dieser Parameter NULL-sein.

[in] SourceFilename

Der Name der Datei, wie sie auf den Quellmedien vorhanden ist, aus denen sie installiert wurde. Dieser Name sollte in einem beliebigen Format für den Aufrufer von Bedeutung sein. Sie sollten eine null--terminated-Zeichenfolge verwenden.

[in] TargetFilename

Der Name der Datei, wie sie im Ziel vorhanden ist. Dieser Name sollte in einem beliebigen Format für den Aufrufer von Bedeutung sein. Sie sollten eine null--terminated-Zeichenfolge verwenden.

[in] Checksum

Optionaler Zeiger auf einen Prüfsummenwert. Erforderlich für das Systemprotokoll.

[in] DiskTagfile

Optionaler Zeiger auf die Tagdatei für die Medien, aus denen die Datei installiert wurde. Sie sollten eine null--terminated-Zeichenfolge verwenden. Die null-terminated string sollte die Größe des Zielpuffers nicht überschreiten. Wird für das Systemprotokoll ignoriert, wenn SPFILELOG_OEMFILE nicht angegeben ist. Erforderlich für das Systemprotokoll, wenn SPFILELOG_OEMFILE angegeben ist. Andernfalls kann dieser Parameter NULL-sein.

[in] DiskDescription

Optionaler Zeiger auf die lesbare Beschreibung des Mediums, aus dem die Datei installiert wurde. Sie sollten eine null--terminated-Zeichenfolge verwenden. Wird für das Systemprotokoll ignoriert, wenn SPFILELOG_OEMFILE nicht im parameter Flags angegeben ist. Erforderlich für das Systemprotokoll, wenn SPFILELOG_OEMFILE im Parameter "Flags" angegeben ist. Andernfalls kann dieser Parameter NULL-sein.

[in] OtherInfo

Optionaler Zeiger auf zusätzliche Informationen, die der Datei zugeordnet werden sollen. Sie sollten eine null--terminated-Zeichenfolge verwenden. Dieser Parameter kann NULL-sein.

[in] Flags

Dieser Parameter kann SPFILELOG_OEMFILE werden, was nur für das Systemprotokoll aussagekräftig ist und angibt, dass die Datei nicht von Microsoft bereitgestellt wird. Dieser Parameter kann verwendet werden, um den Eintrag einer vorhandenen Datei zu konvertieren, z. B. wenn ein OEM eine von Microsoft bereitgestellte Systemdatei überschreibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

Anmerkung

Der Header setupapi.h definiert SetupLogFile als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	setupapi.h
Library	Setupapi.lib
DLL-	Setupapi.dll

Siehe auch

Funktionen

Übersicht

SetupRemoveFileLogEntry-

Freigeben über