SetupQueryFileLogW-Funktion (setupapi.h)

Artikel
03/04/2024

[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 für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin zum Installieren von Gerätetreibern verwendet.]

Die SetupQueryFileLog-Funktion gibt Informationen aus einem Setupdateiprotokoll zurück.

Syntax

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
);

Parameter

[in] FileLogHandle

Behandeln Sie das Dateiprotokoll, das von SetupInitializeFileLog zurückgegeben wird.

[in] LogSectionName

Optionaler Zeiger auf den Abschnittsnamen für die Protokolldatei in einem Format, das für den Aufrufer von Bedeutung ist. Sie sollten eine NULL-Zeichenfolge verwenden. Erforderlich für Nicht-Systemprotokolle. Wenn kein LogSectionName für ein Systemprotokoll angegeben wird, wird ein Standardwert angegeben.

[in] TargetFilename

Name der Datei, für die Protokollinformationen gewünscht sind. Sie sollten eine NULL-Zeichenfolge verwenden.

[in] DesiredInfo

Gibt an, welche Informationen an den DataOut-Puffer zurückgegeben werden sollen. Dieser Parameter kann einer der folgenden aufgezählten Werte sein.

Wert	Bedeutung
SetupFileLogSourceDateiname	Name der Quelldatei, wie sie auf dem Quellmedium vorhanden ist
SetupFileLogChecksum	Ein prüfsummenwert, der vom Systemprotokoll verwendet wird
SetupFileLogDiskTagfile	Name der Tagdatei der Medienquelle, die die Quelldatei enthält
SetupFileLogDiskDescription	Die für Menschen lesbare Beschreibung des Mediums, in dem sich die Quelldatei befindet
SetupFileLogOtherInfo	Zusätzliche Informationen, die der protokollierten Datei zugeordnet sind

Wenn der Wert von DesiredInfo größer als SetupFileLogOtherInfo ist, schlägt die Funktion fehl, und GetLastError gibt ERROR_INVALID_PARAMETER zurück.

[in, out] DataOut

Optionaler Zeiger auf einen Puffer, in dem diese Funktion die angeforderten Informationen für die Datei zurückgibt. Sie sollten eine NULL-Zeichenfolge verwenden. Die NULL-Zeichenfolge sollte die Größe des Zielpuffers nicht überschreiten. Sie können die Funktion einmal aufrufen, um die erforderliche Puffergröße abzurufen, den erforderlichen Arbeitsspeicher zuzuweisen und die Funktion dann ein zweites Mal aufzurufen, um die Daten abzurufen. Weitere Informationen finden Sie im Abschnitt mit den Hinweisen. Mit diesem Verfahren können Sie Fehler aufgrund einer unzureichenden Puffergröße vermeiden. Nicht alle Informationen werden für jede Datei bereitgestellt. Ein Fehler wird nicht zurückgegeben, wenn ein leerer Eintrag für die Datei im Protokoll vorhanden ist. Dieser Parameter kann NULL sein.

[in] ReturnBufferSize

Größe des DataOut-Puffers in Zeichen. Dies schließt den NULL-Abschlussator ein. Wenn der Puffer zu klein ist und DataOut angegeben ist, werden die Daten nicht im Puffer gespeichert, und die Funktion gibt null zurück. Wenn DataOut nicht angegeben ist, wird der ReturnBufferSize-Parameter ignoriert.

[in, out] RequiredSize

Optionaler Zeiger auf eine Variable, die die erforderliche Größe von DataOut in Zeichen empfängt. Diese Zahl enthält den NULL-Abschlussator .

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Nichtzero-Wert.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn diese Funktion mit einem DataOut von NULL und einer ReturnBufferSize von null aufgerufen wird, legt die Funktion die Puffergröße, die zum Halten der angegebenen Daten erforderlich ist, in die Variable ein, auf die von RequiredSize verwiesen wird. Wenn die Funktion in dieser Funktion erfolgreich ist, ist der Rückgabewert ein Nonzero-Wert. Andernfalls ist der Rückgabewert null, und erweiterte Fehlerinformationen können durch Aufrufen von GetLastError abgerufen werden.

Wenn der Wert von DesiredInfo größer als SetupFileLogOtherInfo ist, schlägt die Funktion fehl, und GetLastError gibt ERROR_INVALID_PARAMETER zurück.

Hinweis

Der setupapi.h-Header definiert SetupQueryFileLog 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 nicht codierungsneutralem Code 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

SetupLogFile

Share via