ScanLogContainers-Funktion (clfsw32.h)

Artikel
02/28/2024

Listet Protokollcontainer auf. Rufen Sie diese Funktion wiederholt auf, um alle Protokollcontainer zu durchlaufen.

Syntax

CLFSUSER_API BOOL ScanLogContainers(
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out, optional] LPVOID             pReserved
);

Parameter

[in, out] pcxScan

Ein Zeiger auf eine vom Client zugewiesene CLFS_SCAN_CONTEXT Struktur, die von der CreateLogContainerScanContext-Funktion initialisiert wird.

[in] eScanMode

Der Modus für zu überprüfende Container.

Container können in einem der folgenden CLFS_SCAN_MODE Modi gescannt werden.

Wert	Bedeutung
CLFS_SCAN_INIT	Initialisiert den Überprüfungskontext neu, ordnet den zugeordneten Speicher jedoch nicht zu. Die Initialisierung ist destruktiv, da alle Daten, die im aktuellen Scankontext gespeichert sind, verloren gehen.
CLFS_SCAN_CLOSE	Hebt die Initialisierung des Scankontexts auf und hebt die Zuordnung des Systemspeichers auf, der einem Überprüfungskontext zugeordnet ist.
CLFS_SCAN_FORWARD	Bewirkt, dass der nächste Aufruf von ScanLogContainers vorwärts fortgesetzt wird. Kann nicht verwendet werden, wenn CLFS_SCAN_BACKWARD angegeben ist.
CLFS_SCAN_BACKWARD	Bewirkt, dass der nächste Aufruf von ScanLogContainers rückwärts verläuft. Kann nicht verwendet werden, wenn CLFS_SCAN_FORWARD angegeben ist.

[in, out, optional] pReserved

Reserviert. Legen Sie pReserved auf NULL fest.

Rückgabewert

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

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

Die folgende Liste identifiziert die möglichen Fehlercodes:

Hinweise

Die ID eines Protokollcontainers wird in zurückgegeben: pcxScan-pinfoContainer-LogicalContainerId>>.

Hinweis Die CLFS-Scankontexte (Common Log File System) sind nicht threadsicher. Sie sollten nicht von mehr als einem Thread gleichzeitig verwendet oder an mehrere asynchrone Überprüfungen gleichzeitig übergeben werden.

Beispiele

Ein Beispiel, das diese Funktion verwendet, finden Sie unter Aufzählen von Protokollcontainern.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 R2 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	clfsw32.h
Bibliothek	Clfsw32.lib
DLL	Clfsw32.dll