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

  • Статья

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

Чтобы удалить контейнер, клиент должен иметь права администратора на дескрипторе журнала. Чтобы удалить несколько контейнеров, используйте функцию RemoveLogContainerSet .

Синтаксис

CLFSUSER_API BOOL RemoveLogContainer(
  [in]                HANDLE hLog,
  [in]                LPWSTR pwszContainerPath,
  [in]                BOOL   fForce,
  [in, out, optional] LPVOID pReserved
);

Параметры

[in] hLog

Дескриптор журнала, полученного из CreateLogFile.

[in] pwszContainerPath

Указатель на строку расширенных символов, содержащую путь к контейнеру журнала, созданному с помощью AddLogContainer или AddLogContainerSet.

[in] fForce

Флаг удаления, определяющий, когда и как удаляется контейнер.

Если fForce имеет значение TRUE и контейнер является частью активного региона журнала, контейнер не удаляется и возвращается ошибка ERROR_LOG_CANT_DELETE .

Если значение РАВНО FALSE, контейнер удаляется, если контейнер больше не является частью активного региона журнала.

[in, out, optional] pReserved

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

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

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

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

В следующем списке указаны возможные коды ошибок:

Комментарии

По умолчанию удаление контейнера отложено. Это означает, что контейнер удаляется только в том случае, если он не является частью активного журнала. Если контейнер является частью активного журнала, он помечается для удаления. Однако удаление не происходит до тех пор, пока конец журнала не превысит последний сектор контейнера или контейнер имеет логический идентификатор, превышающий логический идентификатор заголовка активного журнала. Размер журнала отражает удаление контейнера только в том случае, если контейнер удален физически.

Клиент журнала может запросить принудительное удаление контейнера, установив для флага удаления значение TRUE. Это имеет тот же эффект, что и удаление контейнера, который не является частью активного журнала. Однако если контейнер является частью активного журнала, вызов завершается ошибкой, не помечая контейнер для удаления.

Требования

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

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

AddLogContainer

AddLogContainerSet

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

ПЕРЕКРЫВАЮЩИХСЯ

RemoveLogContainerSet