Função RemoveLogContainer (clfsw32.h)
Remove um contêiner de um log associado a um identificador de log dedicado ou multiplexado.
Um cliente deve ter privilégios administrativos no identificador de log para remover um contêiner. Para remover vários contêineres, use a função RemoveLogContainerSet .
Sintaxe
CLFSUSER_API BOOL RemoveLogContainer(
[in] HANDLE hLog,
[in] LPWSTR pwszContainerPath,
[in] BOOL fForce,
[in, out, optional] LPVOID pReserved
);
Parâmetros
[in] hLog
Um identificador para o log obtido de CreateLogFile.
[in] pwszContainerPath
Um ponteiro para uma cadeia de caracteres larga que contém um caminho para um contêiner de log criado por AddLogContainer ou AddLogContainerSet.
[in] fForce
O sinalizador de exclusão que determina quando e como um contêiner é excluído.
Se fForce for TRUE e o contêiner fizer parte da região de log ativa, o contêiner não será excluído e um erro ERROR_LOG_CANT_DELETE será retornado.
Se FALSE, o contêiner será excluído quando o contêiner não fizer mais parte da região de log ativa.
[in, out, optional] pReserved
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á zero. Para obter informações de erro estendidas, chame GetLastError.
A lista a seguir identifica os possíveis códigos de erro:
Comentários
Por padrão, a exclusão de contêiner é lenta, o que significa que um contêiner será excluído somente se ele não fizer parte de um log ativo. Se o contêiner fizer parte do log ativo, ele será marcado para exclusão. No entanto, a exclusão não ocorre até que o final do log exceda o último setor do contêiner ou o contêiner tenha um identificador lógico maior que o identificador lógico do cabeçalho do log ativo. O tamanho do log reflete a exclusão do contêiner somente quando o contêiner é excluído fisicamente.
Um cliente de log pode solicitar uma exclusão forçada em um contêiner definindo o sinalizador de exclusão como TRUE. Isso tem o mesmo efeito que excluir um contêiner que não faz parte do log ativo. No entanto, se o contêiner fizer parte do log ativo, a chamada falhará sem marcar o contêiner para exclusão.
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 |