Функция ClfsDeleteLogFile (wdm.h)
Подпрограмма 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 для удаления.
Если поток, который требуется удалить, является единственным потоком выделенного журнала, имя содержит журнал формы:имя физического журнала, где имя физического журнала — имя пути физического журнала в базовой файловой системе.
Если поток, который требуется удалить, является одним из потоков мультиплексированного журнала, имя имеет журнал формы:имя физического журнала::имя потока, где имя физического журнала — это имя физического журнала в базовой файловой системе и имя потока уникальное имя потока.
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 (include Wdm.h) |
| библиотеки | Clfs.lib |
| DLL | Clfs.sys |
| IRQL | <= APC_LEVEL |