Share via

SetupLogFileA-Funktion (setupapi.h)

  • Artikel

[Diese Funktion ist für die Verwendung in den betriebssystemen verfügbar, die im Abschnitt "Anforderungen" angegeben sind. Es kann in nachfolgenden Versionen geändert oder entfernt werden. SetupAPI sollte nicht mehr zum Installieren von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Installationsprogrammen für Anwendungen. SetupAPI wird weiterhin zum Installieren 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 SetupInitializeFileLog zurückgegeben. Der Aufrufer darf bei der Initialisierung der Protokolldatei nicht SPFILELOG_QUERYONLY übergeben haben.

[in] LogSectionName

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

[in] SourceFilename

Name der Datei, wie sie auf dem Quellmedium vorhanden ist, von dem sie installiert wurde. Dieser Name sollte in beliebigem Format vorliegen, das für den Aufrufer von Bedeutung ist. Sie sollten eine NULL-endende Zeichenfolge verwenden.

[in] TargetFilename

Name der Datei, wie sie auf dem Ziel vorhanden ist. Dieser Name sollte in beliebigem Format vorliegen, das für den Aufrufer von Bedeutung ist. Sie sollten eine NULL-endende Zeichenfolge verwenden.

[in] Checksum

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

[in] DiskTagfile

Optionaler Zeiger auf die Tagdatei für das Medium, auf dem die Datei installiert wurde. Sie sollten eine NULL-endende Zeichenfolge verwenden. Die NULL-Zeichenfolge darf 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, auf dem die Datei installiert wurde. Sie sollten eine NULL-endende Zeichenfolge verwenden. Wird für das Systemprotokoll ignoriert, wenn SPFILELOG_OEMFILE im Flags-Parameter nicht angegeben ist. Erforderlich für das Systemprotokoll, wenn SPFILELOG_OEMFILE im Flags-Parameter 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-endende Zeichenfolge verwenden. Dieser Parameter kann NULL sein.

[in] Flags

Dieser Parameter kann SPFILELOG_OEMFILE sein, was nur für das Systemprotokoll von Bedeutung 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 fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Hinweis

Der Setupapi.h-Header 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
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile setupapi.h
Bibliothek Setupapi.lib
DLL Setupapi.dll

Siehe auch

Funktionen

Übersicht

SetupRemoveFileLogEntry