Función CreateLogContainerScanContext (clfsw32.h)

Artículo
02/23/2024

Crea un contexto de examen para usarlo con ScanLogContainers para enumerar todos los contenedores de registro asociados a un registro y realiza el primer examen.

Sintaxis

CLFSUSER_API BOOL CreateLogContainerScanContext(
  [in]                HANDLE             hLog,
  [in]                ULONG              cFromContainer,
  [in]                ULONG              cContainers,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in, out, optional] LPOVERLAPPED       pOverlapped
);

Parámetros

[in] hLog

Identificador del registro que se obtiene de CreateLogFile con permisos para examinar los contenedores de registro.

El archivo puede ser un registro dedicado o multiplexado.

[in] cFromContainer

Contenedor donde se va a iniciar el examen.

Este parámetro es un número ordinal relativo al número de contenedores del registro.

[in] cContainers

Número de estructuras de CLFS_CONTAINER_INFORMATION para que CreateLogContainerScanContext se asigne.

Este número es el número de contenedores examinados con cada llamada de examen, por lo que el autor de la llamada sabe que el examen se completa cuando el número de contenedores devueltos es menor que este valor.

Al salir, se coloca un puntero a la matriz asignada por el sistema de estructuras de CLFS_CONTAINER_INFORMATION en el miembro pinfoContainer de la estructura de CLFS_SCAN_CONTEXT asignada por el cliente. El parámetro pcxScan apunta a este miembro (es decir, "pcxScan-pinfoContainer>[]") y el número real de estructuras de la matriz se coloca en "pcxScan-cContainersReturned>".

El cliente debe llamar a ScanLogContainers con el parámetro eScanMode establecido en CLFS_SCAN_CLOSE para que pueda liberar esta matriz; de lo contrario, se produce una pérdida de memoria.

[in] eScanMode

Modo para examinar contenedores.

Los contenedores se pueden examinar en cualquiera de los modos siguientes.

Valor	Significado
CLFS_SCAN_INIT	Inicializa o reinicializa un examen desde el primer contenedor de la lista de contenedores. Este modo inicializa el contexto del contenedor y devuelve el primer conjunto de descriptores de contenedor que especifica cContainers .
CLFS_SCAN_FORWARD	Devuelve el primer conjunto de contenedores que especifica cContainers .
CLFS_SCAN_BACKWARD	Devuelve el último conjunto de contenedores que especifica cContainers .

[in, out] pcxScan

Puntero a una estructura de CLFS_SCAN_CONTEXT asignada por el cliente que recibe un contexto de examen que se puede pasar a la función ScanLogContainers cuando un cliente examina los contenedores de registro de un registro dedicado.

[in, out, optional] pOverlapped

Puntero a una estructura SUPERPUESTA necesaria para la operación asincrónica.

Este parámetro puede ser NULL si no se usa una operación asincrónica.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

En la lista siguiente se identifican los posibles códigos de error:

Comentarios

Después de completar un examen, el cliente debe llamar a ScanLogContainers de nuevo con el parámetro eScanMode establecido en CLFS_SCAN_CLOSE para que pueda liberar la matriz asignada por el sistema de estructuras CLFS_CONTAINER_INFORMATION ; de lo contrario, se produce una pérdida de memoria.

Ejemplos

Para obtener un ejemplo que use esta función, vea Enumerar contenedores de registro.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 R2 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	clfsw32.h
Library	Clfsw32.lib
Archivo DLL	Clfsw32.dll