Función ClfsScanLogContainers (wdm.h)
La rutina ClfsScanLogContainers recupera información descriptiva para una secuencia de contenedores que pertenecen a un registro CLFS determinado.
Sintaxis
CLFSUSER_API NTSTATUS ClfsScanLogContainers(
[in, out] PCLFS_SCAN_CONTEXT pcxScan,
[in] CLFS_SCAN_MODE eScanMode
);
Parámetros
[in, out] pcxScan
Puntero a una estructura de CLFS_SCAN_CONTEXT . El autor de la llamada asignó previamente la estructura y la inicializó llamando a ClfsCreateScanContext. En concreto, el miembro pInfoContainer se inicializó para apuntar a una matriz de estructuras de CLFS_CONTAINER_INFORMATION y el miembro cContainers se inicializó en el número de elementos de la matriz. Al devolver, las estructuras de la matriz reciben información descriptiva para los contenedores de la secuencia.
[in] eScanMode
Conjunto de marcas que especifican la dirección del examen y si se debe cerrar el contexto del examen. Las marcas siguientes están disponibles para los autores de llamadas de esta rutina.
| Valor | Significado |
|---|---|
| CLFS_SCAN_FORWARD | Escanear en la dirección hacia delante. Por ejemplo, si el contenedor 5 es el contenedor examinado más recientemente y pxcScan->cContainers es igual a dos, esta rutina devolverá descriptores para los contenedores 6 y 7. |
| CLFS_SCAN_BACKWARD | Escanear en la dirección hacia atrás. Por ejemplo, si el contenedor 5 es el contenedor examinado más recientemente y pxcScan->cContainers es igual a dos, esta rutina devolverá descriptores para los contenedores 4 y 3. |
| CLFS_SCAN_CLOSE | Libere todos los recursos asociados al contexto de examen al que apunta pcxScan. |
Si se establece la marca CLFS_SCAN_CLOSE, las marcas de CLFS_SCAN_FORWARD y CLFS_SCAN_BACKWARD deben estar claras.
Si la marca CLFS_SCAN_CLOSE está desactivada, solo se debe establecer una de las marcas de dirección (CLFS_SCAN_FORWARD o CLFS_SCAN_BACKWARD).
Valor devuelto
ClfsScanLogContainers devuelve STATUS_SUCCESS si se realiza correctamente; de lo contrario, devuelve uno de los códigos de error definidos en Ntstatus.h.
Comentarios
CLFS usa la estructura de CLFS_SCAN_CONTEXT para realizar un seguimiento de dónde se inicia un examen de contenedor (el miembro cIndex ) y cuántos contenedores se examinan en cada llamada a ClfsScanLogContainers. El valor N del miembro cContainers especifica que cada vez que se llama a ClfsScanLogContainers , se examinan los siguientes contenedores N.
El miembro cContainersReturned de la estructura de CLFS_SCAN_CONTEXT recibe el número de contenedores que se examinan realmente en una sola llamada a ClfsScanLogContainers.
Cuando ClfsScanLogContainers devuelve STATUS_NO_MORE_ENTRIES, no hay más contenedores que se van a examinar.
Cuando haya terminado de usar el contexto de examen al que apunta pcxScan, debe llamar a ClfsScanLogContainers, con eScanMode igual a CLFS_SCAN_CLOSE, para liberar los recursos asociados con el contexto de examen.
Para obtener una explicación de los conceptos y la terminología de CLFS, consulte Common Log File System.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Disponible en Windows Server 2003 R2, Windows Vista y versiones posteriores de Windows. |
| Plataforma de destino | Escritorio |
| Encabezado | wdm.h (incluya Wdm.h, Ntddk.h, Ntifs.h) |
| Library | Clfs.lib |
| Archivo DLL | Clfs.sys |
| IRQL | <= APC_LEVEL |