Função CreateLogContainerScanContext (clfsw32.h)

Artigo
08/22/2023

Cria um contexto de verificação para usar com ScanLogContainers para enumerar todos os contêineres de log associados a um log e executa a primeira verificação.

Sintaxe

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

Um identificador para o log obtido de CreateLogFile com permissões para verificar os contêineres de log.

O arquivo pode ser um log dedicado ou multiplexado.

[in] cFromContainer

O contêiner em que a verificação deve ser iniciada.

Esse parâmetro é um número ordinal relativo ao número de contêineres no log.

[in] cContainers

O número de estruturas de CLFS_CONTAINER_INFORMATION para CreateLogContainerScanContext a alocar.

Esse número é o número de contêineres verificados com cada chamada de verificação para que o chamador saiba que a verificação está concluída quando o número de contêineres retornados for menor que esse valor.

Na saída, um ponteiro para a matriz alocada pelo sistema de estruturas de CLFS_CONTAINER_INFORMATION é colocado no membro pinfoContainer da estrutura de CLFS_SCAN_CONTEXT alocada pelo cliente. Esse membro é apontado pelo parâmetro pcxScan (ou seja, "pcxScan-pinfoContainer>[]"), e o número real de estruturas na matriz é colocado em "pcxScan-cContainersReturned>".

O cliente deve chamar ScanLogContainers com o parâmetro eScanMode definido como CLFS_SCAN_CLOSE para que ele possa liberar essa matriz; caso contrário, perda de memória resulta.

[in] eScanMode

O modo para verificar contêineres.

Os contêineres podem ser verificados em qualquer um dos modos a seguir.

Valor	Significado
CLFS_SCAN_INIT	Inicializa ou reinicializa uma verificação do primeiro contêiner na lista de contêineres. Esse modo inicializa o contexto do contêiner e retorna o primeiro conjunto de descritores de contêiner especificados por cContainers .
CLFS_SCAN_FORWARD	Retorna o primeiro conjunto de contêineres especificado por cContainers .
CLFS_SCAN_BACKWARD	Retorna o último conjunto de contêineres especificado por cContainers .

[in, out] pcxScan

Um ponteiro para uma estrutura de CLFS_SCAN_CONTEXT alocada pelo cliente que recebe um contexto de verificação que pode ser passado para a função ScanLogContainers quando um cliente verifica os contêineres de log de um log dedicado.

[in, out, optional] pOverlapped

Um ponteiro para uma estrutura OVERLAPPED necessária para a operação assíncrona.

Esse parâmetro poderá ser NULL se uma operação assíncrona não for usada.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

A lista a seguir identifica os possíveis códigos de erro:

Comentários

Depois de concluir uma verificação, o cliente deve chamar ScanLogContainers novamente com o parâmetro eScanMode definido como CLFS_SCAN_CLOSE para que ele possa liberar a matriz alocada pelo sistema de estruturas CLFS_CONTAINER_INFORMATION ; caso contrário, perda de memória resulta.

Exemplos

Para obter um exemplo que usa essa função, consulte Enumerando contêineres de log.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	clfsw32.h
Biblioteca	Clfsw32.lib
DLL	Clfsw32.dll