Функция DeleteLogByHandle (clfsw32.h)

  • Статья

Помечает указанный журнал для удаления. Журнал фактически удаляется при закрытии всех дескрипторов, областей маршалинга и контекстов чтения в журнале. Если журнал является физическим журналом, его базовые контейнеры удаляются.

Если журнал помечен для удаления, запросы на открытие новых потоков журналов клиента завершаются ошибкой.

Примечание Эта функция отличается от DeleteLogFile, так как она принимает допустимый открытый дескриптор для объекта журнала вместо имени журнала.
 

Синтаксис

CLFSUSER_API BOOL DeleteLogByHandle(
  [in] HANDLE hLog
);

Параметры

[in] hLog

Дескриптор открытого журнала, полученного при успешном вызове CreateLogFile. Журнал должен быть создан с доступом DELETE, иначе его нельзя удалить.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция завершается сбоем, возвращаемое значение равно нулю (0). Дополнительные сведения об ошибке можно получить, вызвав GetLastError. В следующем списке указаны возможные коды ошибок:

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 R2 [только классические приложения]
Целевая платформа Windows
Header clfsw32.h
Библиотека Clfsw32.lib
DLL Clfsw32.dll

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

Общие функции файловой системы журнала

CreateLogFile

DeleteLogFile