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

Статья
11/20/2024

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

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

Примечание Тесно связанная функция DeleteLogByHandle, которая удаляет журнал при указании дескриптора файла.

Синтаксис

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

Параметры

[in] pszLogFileName

Имя журнала.

Это имя указывается при создании журнала с помощью CreateLogFile. В следующем примере определяется формат, используемый:

журнал :<имя журнала>[::<имя потока журнала>]

< имя журнала> соответствует допустимому пути к файлу в файловой системе.

< имя потока журнала> — уникальное имя потока журнала в журнале.

Дополнительные сведения см. втипов журналов .

[in, optional] pvReserved

Этот параметр зарезервирован и должен иметь значение NULL.

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

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

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2003 R2 [только классические приложения]
целевая платформа	Виндоус
заголовка	clfsw32.h
библиотеки	Clfsw32.lib
DLL	Clfsw32.dll

См. также

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

CreateLogFile

DeleteLogByHandle

SECURITY_ATTRIBUTES

Поделиться через