SetupQueryFileLogA-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 SetupQueryFileLog Funktion gibt Informationen aus einem Setupdateiprotokoll zurück.

Syntax

WINSETUPAPI BOOL SetupQueryFileLogA(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCSTR            LogSectionName,
  [in]      PCSTR            TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PSTR             DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

Parameter

[in] FileLogHandle

Behandeln Sie das Dateiprotokoll, wie von SetupInitializeFileLogzurückgegeben.

[in] LogSectionName

Optionaler Zeiger auf den Abschnittsnamen für die Protokolldatei in einem Format, das für den Aufrufer aussagekräftig ist. Sie sollten eine null--terminated-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 werden. Sie sollten eine null--terminated-Zeichenfolge verwenden.

[in] DesiredInfo

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

Wert	Bedeutung
SetupFileLogSourceFile-Name	Name der Quelldatei, wie sie auf den Quellmedien vorhanden ist
SetupFileLogChecksum-	Ein vom Systemprotokoll verwendeter Prüfsummenwert
SetupFileLogDiskTagfile-	Name der Tagdatei der Medienquelle, die die Quelldatei enthält
SetupFileLogDiskDescription-	Die lesbare Beschreibung der Medien, in denen 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--terminated-Zeichenfolge verwenden. Die null-terminated string 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 dann die Funktion ein zweites Mal aufzurufen, um die Daten abzurufen. Weitere Informationen finden Sie im Abschnitt "Hinweise". Mithilfe dieser Technik können Sie Fehler aufgrund einer unzureichenden Puffergröße vermeiden. Nicht alle Informationen werden für jede Datei bereitgestellt. Wenn im Protokoll ein leerer Eintrag für die Datei vorhanden ist, wird kein Fehler zurückgegeben. Dieser Parameter kann NULL-sein.

[in] ReturnBufferSize

Größe des DataOut- Puffers in Zeichen. Dies schließt den null Terminator ein. Wenn der Puffer zu klein ist und DataOut- angegeben wird, 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 Endator.

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

Wenn diese Funktion mit einem DataOut- von NULL- und einer ReturnBufferSize- null aufgerufen wird, übergibt die Funktion die puffergröße, die erforderlich ist, um die angegebenen Daten in die Variable einzuspeichern, auf die durch RequiredSizeverwiesen wird. Wenn die Funktion in diesem Fall erfolgreich ausgeführt wird, ist der Rückgabewert ein Wert ungleich Null. Andernfalls ist der Rückgabewert null und erweiterte Fehlerinformationen können durch Aufrufen von GetLastErrorabgerufen werden.

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

Anmerkung

Der Header setupapi.h definiert SetupQueryFileLog als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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

SetupLogFile-

Freigeben über