Função DeleteLogFile (clfsw32.h)

  • Artigo

Marca um log para exclusão. Na verdade, o log é excluído quando todos os identificadores, áreas de marshaling e contextos de leitura para o log são fechados. Se o log for um log físico, seus contêineres subjacentes serão excluídos.

Quando um log é marcado para exclusão, as solicitações para abrir novos fluxos de log do cliente falham.

Nota Uma função intimamente relacionada é DeleteLogByHandle, que exclui um log quando dado o identificador do arquivo.

 

Sintaxe

CLFSUSER_API BOOL DeleteLogFile(
  [in]           LPCWSTR pszLogFileName,
  [in, optional] PVOID   pvReserved
);

Parâmetros

[in] pszLogFileName

O nome do log.

Esse nome é especificado ao criar o log usando CreateLogFile. O exemplo a seguir identifica o formato a ser usado:

Log:<nome>do log[::nome do< fluxo de log]>

<nome> do log corresponde a um caminho de arquivo válido no sistema de arquivos.

<nome >do fluxo de log é o nome exclusivo de um fluxo de log no log.

Para obter mais informações, consulte Tipos de log.

[in, optional] pvReserved

Esse parâmetro é reservado e deve ser definido como NULL.

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á 0 (zero). Para obter informações de erro estendidas, chame GetLastError. A lista a seguir identifica os possíveis códigos de erro:

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

Confira também

Funções comuns do sistema de arquivos de log

CreateLogFile

DeleteLogByHandle

SECURITY_ATTRIBUTES