ClfsScanLogContainers-Funktion (wdm.h)
Die ClfsScanLogContainers Routine ruft beschreibende Informationen für eine Abfolge 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 zugewiesen und initialisiert, indem ClfsCreateScanContextaufgerufen wird. Insbesondere wurde das pInfoContainer Member initialisiert, um auf ein Array von CLFS_CONTAINER_INFORMATION Strukturen zu verweisen, und das cContainers Member wurde in die Anzahl der Elemente im Array initialisiert. Im Gegenzug erhalten die Strukturen im Array beschreibende Informationen für die Container in der Sequenz.
[in] eScanMode
Eine Reihe von Flags, die die Richtung des Scans angeben und ob der Scankontext geschlossen werden soll. Die folgenden Flags stehen Anrufern dieser Routine zur Verfügung.
| Wert | Bedeutung |
|---|---|
| CLFS_SCAN_FORWARD | Scannen Sie in die Vorwärtsrichtung. Wenn Container 5 beispielsweise der zuletzt gescannte Container ist und pxcScan->cContainers gleich zwei ist, gibt diese Routine Deskriptoren für Container 6 und 7 zurück. |
| CLFS_SCAN_BACKWARD | Scannen Sie in die Rückwärtsrichtung. Wenn Container 5 beispielsweise der zuletzt gescannte Container ist und pxcScan->cContainers gleich zwei ist, gibt diese Routine Deskriptoren für Container 4 und 3 zurück. |
| CLFS_SCAN_CLOSE | Geben Sie alle Ressourcen frei, die mit dem Scankontext verknüpft sind, auf den pcxScanverweist. |
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 CLFS_SCAN_CLOSE Flag eindeutig ist, müssen nur eine der Richtungskennzeichnungen (CLFS_SCAN_FORWARD oder CLFS_SCAN_BACKWARD) festgelegt werden.
Rückgabewert
ClfsScanLogContainers gibt STATUS_SUCCESS zurück, wenn dies erfolgreich ist; andernfalls wird eine der fehlercodes zurückgegeben, die in Ntstatus.h definiert sind.
Bemerkungen
CLFS verwendet die CLFS_SCAN_CONTEXT Struktur, um nachzuverfolgen, wo ein Containerscan gestartet wird (das cIndex Member) und wie viele Container in jedem Aufruf von ClfsScanLogContainersgescannt werden. Der Wert N des cContainers Member gibt an, dass bei jedem Aufruf ClfsScanLogContainers die nächsten N-Container gescannt werden.
Das cContainersReturned Member der CLFS_SCAN_CONTEXT-Struktur empfängt die Anzahl der Container, die tatsächlich in einem einzigen Aufruf von ClfsScanLogContainersgescannt wurden.
Wenn ClfsScanLogContainers STATUS_NO_MORE_ENTRIES zurückgibt, sind keine container mehr zu scannen.
Wenn Sie den Scankontext verwendet haben, auf den pcxScanverweist, müssen Sie ClfsScanLogContainersaufrufen, 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.
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, Ntddk.h, Ntifs.h) |
| Library | Clfs.lib |
| DLL- | Clfs.sys |
| IRQL- | <= APC_LEVEL |