ClfsScanLogContainers-Funktion (wdm.h)

Die ClfsScanLogContainers-Routine ruft beschreibende Informationen für eine Sequenz von Containern ab, die zu einem bestimmten CLFS-Protokoll gehören.

Syntax

CLFSUSER_API NTSTATUS ClfsScanLogContainers(
  [in, out] PCLFS_SCAN_CONTEXT pcxScan,
  [in]      CLFS_SCAN_MODE     eScanMode
);

Parameter

[in, out] pcxScan

Ein Zeiger auf eine CLFS_SCAN_CONTEXT-Struktur . Der Aufrufer hat die Struktur zuvor zugeordnet und durch Aufrufen von ClfsCreateScanContext initialisiert. Insbesondere wurde das pInfoContainer-Element initialisiert, um auf ein Array von CLFS_CONTAINER_INFORMATION-Strukturen zu verweisen, und das cContainers-Element wurde mit der Anzahl der Elemente im Array initialisiert. Bei der Rückgabe erhalten die Strukturen im Array beschreibende Informationen für die Container in der Sequenz.

[in] eScanMode

Ein Satz von Flags, die die Richtung der Überprüfung angeben und angeben, ob der Scankontext geschlossen werden soll. Die folgenden Flags sind für Aufrufer dieser Routine verfügbar.

Wert	Bedeutung
CLFS_SCAN_FORWARD	Scan in vorwärts gerichteter Richtung. Wenn beispielsweise Container 5 der zuletzt gescannte Container ist und pxcScan->cContainers gleich zwei ist, gibt diese Routine Deskriptoren für die Container 6 und 7 zurück.
CLFS_SCAN_BACKWARD	Scan in rückwärts gerichteter Richtung. Wenn beispielsweise Container 5 der zuletzt gescannte Container ist und pxcScan->cContainers gleich zwei ist, gibt diese Routine Deskriptoren für die Container 4 und 3 zurück.
CLFS_SCAN_CLOSE	Geben Sie alle Ressourcen frei, die dem Scankontext zugeordnet sind, auf den pcxScan verweist.

 

Wenn das CLFS_SCAN_CLOSE-Flag festgelegt ist, müssen sowohl die CLFS_SCAN_FORWARD- als auch die CLFS_SCAN_BACKWARD-Flags klar sein.

Wenn das flag CLFS_SCAN_CLOSE eindeutig ist, muss nur eines der Richtungsflags (CLFS_SCAN_FORWARD oder CLFS_SCAN_BACKWARD) festgelegt werden.

Rückgabewert

ClfsScanLogContainers gibt bei Erfolg STATUS_SUCCESS zurück. Andernfalls wird einer der in "Ntstatus.h" definierten Fehlercodes zurückgegeben.

Hinweise

CLFS verwendet die CLFS_SCAN_CONTEXT-Struktur , um nachzuverfolgen, wo eine Containerüberprüfung beginnt (das cIndex-Element ) und wie viele Container in jedem Aufruf von ClfsScanLogContainers überprüft werden. Der Wert N des cContainers-Elements gibt an, dass bei jedem Aufruf von ClfsScanLogContainers die nächsten N-Container überprüft werden.

Das cContainersReturned-Element der CLFS_SCAN_CONTEXT-Struktur empfängt die Anzahl der Container, die tatsächlich in einem einzigen Aufruf von ClfsScanLogContainers gescannt wurden.

Wenn ClfsScanLogContainers STATUS_NO_MORE_ENTRIES zurückgibt, sind keine container mehr zu überprüfen.

Wenn Sie die Verwendung des Scankontexts abgeschlossen haben, auf den pcxScan verweist, müssen Sie ClfsScanLogContainers aufrufen, wobei eScanMode gleich CLFS_SCAN_CLOSE ist, um alle Ressourcen freizugeben, die dem Scankontext zugeordnet sind.

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows Server 2003 R2, Windows Vista und höheren Versionen von Windows.
Zielplattform	Desktop
Header	wdm.h (einschließlich Wdm.h, Ntddk.h, Ntifs.h)
Bibliothek	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

Weitere Informationen

CLFS_CONTAINER_INFORMATION

CLFS_SCAN_CONTEXT

ClfsCreateScanContext