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

  • Статья

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

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

Примечание Тесно связанная функция — 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 [только классические приложения]
Целевая платформа Windows
Header clfsw32.h
Библиотека Clfsw32.lib
DLL Clfsw32.dll

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

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

CreateLogFile

DeleteLogByHandle

SECURITY_ATTRIBUTES