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

Статья
08/22/2023

Извлекает полное имя пути к указанному контейнеру. Эта функция используется главным образом для получения полного пути к контейнеру, на который ссылается структура CLFS_CONTAINER_INFORMATION , возвращаемая в вызовах ScanLogContainers.

Синтаксис

CLFSUSER_API BOOL GetLogContainerName(
  [in]                HANDLE            hLog,
  [in]                CLFS_CONTAINER_ID cidLogicalContainer,
  [in, out]           LPCWSTR           pwstrContainerName,
  [in]                ULONG             cLenContainerName,
  [in, out, optional] PULONG            pcActualLenContainerName
);

Параметры

[in] hLog

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

Дескриптор журнала может ссылаться на поток журнала или физический журнал.

[in] cidLogicalContainer

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

[in, out] pwstrContainerName

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

[in] cLenContainerName

Размер буфера, на который указывает pwstrContainerName, в символах.

[in, out, optional] pcActualLenContainerName

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

Если функция выполняется успешно, значение этого параметра меньше или равно cLenContainerName. Если буфер недостаточно велик для хранения всего имени пути к контейнеру, функция завершается сбоем с ERROR_MORE_DATA и задает этому параметру размер, необходимый для полного имени пути. Для других сбоев значение не определено.

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

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

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

Требования

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

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

CLFS_CONTAINER_INFORMATION

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

ScanLogContainers

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