Função ClfsGetContainerName (wdm.h)

Artigo
02/07/2025

A rotina ClfsGetContainerName retorna o nome do caminho de um contêiner especificado.

Sintaxe

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

Parâmetros

[in] plfoLog

Um ponteiro para uma estrutura de LOG_FILE_OBJECT que representa um log CLFS. O chamador obteve esse ponteiro anteriormente chamando ClfsCreateLogFile.

[in] cidLogicalContainer

O identificador lógico de um contêiner no log CLFS.

[out] puszContainerName

Um ponteiro para uma estrutura UNICODE_STRING. O buffer membro do puszContainerName deve apontar para um buffer alocado pelo chamador que recebe o nome do caminho do contêiner. O membro do MaximumLength deve fornecer o tamanho do buffer.

[out, optional] pcActualLenContainerName

Um ponteiro para uma variável do tipo ULONG que recebe o comprimento real, em caracteres Unicode, do nome do caminho do contêiner. Esse parâmetro pode ser NULL.

Valor de retorno

ClfsGetContainerName retorna um dos códigos de status definidos em Ntstatus.h. A tabela a seguir fornece os significados de vários valores retornados.

Código de retorno	Descrição
STATUS_SUCCESS	O Buffer membro do puszContainerName recebe o nome completo do caminho do contêiner. Se pcActualLenContainerName não for NULL, ele receberá o comprimento real, em caracteres Unicode, do nome do caminho completo.
STATUS_BUFFER_OVERFLOW	O comprimento real, em caracteres Unicode, do nome do caminho completo é maior que puszContainerName->MaximumLength. O do Buffer membro do puszContainerName recebe o nome completo do caminho do contêiner truncado para o número de caracteres especificado por puszContainerName->MaximumLength. Se pcActualLenContainerName não for NULL, ele receberá o comprimento real, em caracteres Unicode, do nome do caminho completo.
Outros	No retorno, o conteúdo de puszContainerName->Buffer e pcActualLenContainerName são indefinidos.

Observações

Para obter uma explicação dos conceitos e terminologia do CLFS, consulte Common Log File System.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível no Windows Server 2003 R2, Windows Vista e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	wdm.h (inclua Wdm.h)
biblioteca	Clfs.lib
de DLL	Clfs.sys
IRQL	<= APC_LEVEL

Consulte também

ClfsAddLogContainer

ClfsRemoveLogContainer

Partilhar via