Функция ClfsGetContainerName (wdm.h)

2025-02-07

Подпрограмма clfsGetContainerName возвращает имя пути указанного контейнера.

Синтаксис

CLFSUSER_API NTSTATUS ClfsGetContainerName(
  [in]            PLOG_FILE_OBJECT  plfoLog,
  [in]            CLFS_CONTAINER_ID cidLogicalContainer,
  [out]           PUNICODE_STRING   puszContainerName,
  [out, optional] PULONG            pcActualLenContainerName
);

Параметры

[in] plfoLog

Указатель на структуру LOG_FILE_OBJECT, представляющую журнал CLFS. Вызывающий объект ранее получил этот указатель путем вызова ClfsCreateLogFile.

[in] cidLogicalContainer

Логический идентификатор контейнера в журнале CLFS.

[out] puszContainerName

Указатель на структуру UNICODE_STRING. Элемент буфераpuszContainerName должен указывать на выделенный вызывающим буфером, который получает имя пути контейнера. Элемент MaximumLength должен предоставить размер буфера.

[out, optional] pcActualLenContainerName

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

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

ClfsGetContainerName возвращает один из кодов состояния, определенных в Ntstatus.h. В следующей таблице приведены значения различных возвращаемых значений.

Возвращаемый код	Описание
STATUS_SUCCESS	Элемент buffer элемента puszContainerName получает полное имя контейнера. Если pcActualLenContainerName не NULL, он получает фактическую длину в символах Юникода из полного имени пути.
STATUS_BUFFER_OVERFLOW	Фактическая длина в символах Юникода для имени полного пути превышает puszContainerName->MaximumLength. Элемент буфераpuszContainerName получает полное имя контейнера, усеченное до количества символов, указанных puszContainerName->MaximumLength. Если pcActualLenContainerName не NULL, он получает фактическую длину в символах Юникода из полного имени пути.
Другие	При возврате содержимое puszContainerName->буфера и pcActualLenContainerName не определены.

Замечания

Описание концепций и терминологии CLFS см. в common Log File System.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Windows Server 2003 R2, Windows Vista и более поздних версиях Windows.
целевая платформа	Настольный
заголовка	wdm.h (include Wdm.h)
библиотеки	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

См. также

ClfsAddLogContainer

ClfsRemoveLogContainer