Функция ClfsDeleteLogFile (wdm.h)

Статья
08/08/2023

Подпрограмма ClfsDeleteLogFile помечает поток CLFS для удаления.

Синтаксис

CLFSUSER_API NTSTATUS ClfsDeleteLogFile(
  [in]           PUNICODE_STRING puszLogFileName,
                 PVOID           pvReserved,
  [in]           ULONG           fLogOptionFlag,
  [in, optional] PVOID           pvContext,
  [in]           ULONG           cbContext
);

Параметры

[in] puszLogFileName

Указатель на структуру UNICODE_STRING , которая предоставляет имя удаляемого потока CLFS.

Если поток, который требуется удалить, является единственным потоком выделенного журнала, имя имеет форму log:имя физического журнала, где имя физического журнала — это имя пути к физическому журналу в базовой файловой системе.

Если удаляемый поток является одним из потоков мультиплексированного журнала, имя имеет форму log:physical log name::stream name, где имя физического журнала — это имя пути физического журнала в базовой файловой системе, а имя потока — уникальное имя удаляемого потока.

pvReserved

Зарезервировано.

[in] fLogOptionFlag

Значение типа , указывающее связь между CLFS и компонентом, удаляющим журнал. Список возможных значений см. в описании параметра fLogOptionFlag подпрограммы ClfsCreateLogFile .

[in, optional] pvContext

Указатель на контекст. Способ интерпретации контекста зависит от значения, переданного в fLogOptionFlag.

[in] cbContext

Размер (в байтах) контекста, на который указывает pvContext. Если pvContext не равно NULL, этот параметр должен быть больше нуля.

Возвращаемое значение

ClfsDeleteLogFile возвращает STATUS_SUCCESS в случае успешного выполнения; в противном случае возвращается один из кодов ошибок, определенных в ntstatus.h.

Общая файловая система журналов (CLFS) использует структуру LOG_FILE_OBJECT для представления журналов. Функция ClfsCreateLogFile возвращает указатель на LOG_FILE_OBJECT, который клиенты затем передают другим функциям CLFS.

Клиенты CLFS не обращаются напрямую к членам структуры LOG_FILE_OBJECT. Сведения о членах см. в разделе FILE_OBJECT.

ClfsDeleteLogFile помечает поток для удаления, но не закрывает объекты файлов журнала, которые в настоящее время открыты. Чтобы закрыть объект файла журнала, вызовите ClfsCloseLogFileObject. Поток, помеченный для удаления, удаляется после закрытия всех объектов файлов журнала, связанных с потоком.

Поток CLFS, помеченный для удаления, будет отклонять последующие запросы на открытие потока.

Имя физического журнала CLFS не включает расширение BLF.

Описание концепций и терминологии CLFS см. в разделе Common Log File System.

Требования

Требование	Значение
Минимальная версия клиента	Доступно в Windows Server 2003 R2, Windows Vista и более поздних версиях Windows.
Целевая платформа	Персональный компьютер
Верхняя часть	wdm.h (включая Wdm.h)
Библиотека	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

См. также раздел

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsCreateLogFile

ClfsDeleteLogByPointer