ClfsCreateScanContext-Funktion (wdm.h)

Artikel
02/07/2025

Die ClfsCreateScanContext Routine erstellt einen Scankontext, der zum Durchlaufen der Container eines angegebenen CLFS-Protokolls verwendet werden kann.

Syntax

CLFSUSER_API NTSTATUS ClfsCreateScanContext(
  [in]      PLOG_FILE_OBJECT   plfoLog,
  [in]      ULONG              cFromContainer,
  [in]      ULONG              cContainers,
  [in]      CLFS_SCAN_MODE     eScanMode,
  [in, out] PCLFS_SCAN_CONTEXT pcxScan
);

Parameter

[in] plfoLog

Ein Zeiger auf eine LOG_FILE_OBJECT Struktur, die einen CLFS-Datenstrom darstellt. Der Scankontext wird für das Protokoll erstellt, das den zugrunde liegenden Speicher für diesen Datenstrom bereitstellt. Der Aufrufer hat diesen Zeiger zuvor durch Aufrufen ClfsCreateLogFileabgerufen.

[in] cFromContainer

Der Index des ersten zu scannenden Containers. Container werden beginnend bei Null indiziert.

[in] cContainers

Die Anzahl der Container, die mit jedem Aufruf von ClfsScanLogContainersgescannt werden sollen.

[in] eScanMode

Eine Reihe von Flags, die angeben, ob der Scankontext für das Vorwärts- oder Rückwärtsscannen eingerichtet ist und ob der Scankontext erneut initialisiert werden soll. Die folgenden drei Flags sind für Anrufer dieser Routine verfügbar.

Wert	Bedeutung
CLFS_SCAN_FORWARD	Richten Sie den Scankontext für das Scannen in die Vorwärtsrichtung ein. Wenn Container 5 beispielsweise der zuletzt gescannte Container ist und cContainers 2 ist, würde eine Weiterleitungsüberprüfung Deskriptoren für Container 6 und 7 zurückgeben.
CLFS_SCAN_BACKWARD	Richten Sie den Scankontext für das Scannen in die Rückwärtsrichtung ein. Wenn Container 5 beispielsweise der zuletzt gescannte Container ist und cContainers 2 ist, würde eine Rückwärtsüberprüfung Deskriptoren für Container 4 und 3 zurückgeben.
CLFS_SCAN_INIT	Initialisieren Sie den Scankontext erneut. Wenn ClfsScanLogContainers das nächste Mal aufgerufen wird, verhält es sich so, als ob sie nach der Erstellung des Scankontexts zum ersten Mal aufgerufen wurde.

Wenn pcxScan- auf eine CLFS_SCAN_CONTEXT Struktur zeigt, die zum ersten Mal an diese Routine übergeben wird, muss eine der Richtungskennzeichnungen (CLFS_SCAN_FORWARD oder CLFS_SCAN_BACKWARD) festgelegt werden. Das CLFS_SCAN_INIT Flag darf nicht festgelegt werden.

Wenn pcxScan- auf eine CLFS_SCAN_CONTEXT Struktur verweist, die zuvor an diese Routine übergeben wurde, muss das CLFS_SCAN_INIT-Flag festgelegt werden. Außerdem muss nur eine der Richtungskennzeichnungen (CLFS_SCAN_FORWARD oder CLFS_SCAN_BACKWARD) festgelegt werden.

[in, out] pcxScan

Ein Zeiger auf eine vom Aufrufer zugewiesene CLFS_SCAN_CONTEXT Struktur, deren Member durch diese Routine initialisiert werden. Diese Struktur wird später an ClfsScanLogContainersübergeben.

Rückgabewert

ClfsCreateScanContext gibt STATUS_SUCCESS zurück, wenn er erfolgreich ist; andernfalls wird eine der Fehlercodes in Ntstatus.h zurückgegeben.

Bemerkungen

Eine Erläuterung der CLFS-Konzepte und -Terminologie finden Sie unter Common Log File System.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar in Windows Server 2003 R2, Windows Vista und höheren Versionen von Windows.
Zielplattform-	Desktop
Header-	wdm.h (include Wdm.h)
Library	Clfs.lib
DLL-	Clfs.sys
IRQL-	<= APC_LEVEL

Siehe auch

ClfsScanLogContainers

Freigeben über