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


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

Подпрограмма 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 . Элемент Bufferобъекта puszContainerName должен указывать на буфер, выделенный вызывающим объектом, который получает путь к контейнеру. Член MaximumLength должен указывать размер буфера.

[out, optional] pcActualLenContainerName

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

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

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

Код возврата Описание
STATUS_SUCCESS
Элемент Buffer объекта puszContainerName получает полный путь к контейнеру. Если pcActualLenContainerName не равно NULL, он получает фактическую длину полного имени пути в символах Юникода.
STATUS_BUFFER_OVERFLOW
Фактическая длина полного имени пути в символах Юникода больше, чем имя максимального значения puszContainerName->. Член буфераpuszContainerName получает полный путь к контейнеру, усеченный до числа символов, указанного параметромmaximumLengthpuszContainerName->. Если pcActualLenContainerName не равно NULL, он получает фактическую длину полного имени пути в символах Юникода.
Другое
При возврате содержимое буфера puszContainerName-> и pcActualLenContainerName не определено.

Комментарии

Описание основных понятий и терминологии CLFS см. в разделе Common Log File System.

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows Server 2003 R2, Windows Vista и более поздних версиях Windows.
Целевая платформа Персональный компьютер
Верхняя часть wdm.h (включая Wdm.h)
Библиотека Clfs.lib
DLL Clfs.sys
IRQL <= APC_LEVEL

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

ClfsAddLogContainer

ClfsRemoveLogContainer