Función ClfsGetContainerName (wdm.h)

  • Artículo

La rutina ClfsGetContainerName devuelve el nombre de ruta de acceso de un contenedor especificado.

Sintaxis

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

Puntero a una estructura de LOG_FILE_OBJECT que representa un registro CLFS. El autor de la llamada obtuvo previamente este puntero mediante una llamada a ClfsCreateLogFile.

[in] cidLogicalContainer

Identificador lógico de un contenedor en el registro clFS.

[out] puszContainerName

Puntero a una estructura UNICODE_STRING . El miembro Buffer de puszContainerName debe apuntar a un búfer asignado por el autor de la llamada que recibe el nombre de ruta de acceso del contenedor. El miembro MaximumLength debe proporcionar el tamaño del búfer.

[out, optional] pcActualLenContainerName

Puntero a una variable con tipo ULONG que recibe la longitud real, en caracteres Unicode, del nombre de la ruta de acceso del contenedor. Este parámetro puede ser NULL.

Valor devuelto

ClfsGetContainerName devuelve uno de los códigos de estado definidos en Ntstatus.h. En la tabla siguiente se proporcionan los significados de varios valores devueltos.

Código devuelto Descripción
STATUS_SUCCESS
 El miembro Buffer de puszContainerName recibe el nombre de ruta de acceso completo del contenedor. Si pcActualLenContainerName no es NULL, recibe la longitud real, en caracteres Unicode, del nombre de ruta de acceso completo.
STATUS_BUFFER_OVERFLOW
 La longitud real, en caracteres Unicode, del nombre de ruta de acceso completa es mayor que puszContainerName->MaximumLength. El miembro Buffer de puszContainerName recibe el nombre de ruta de acceso completo del contenedor truncado al número de caracteres especificados por puszContainerName->MaximumLength. Si pcActualLenContainerName no es NULL, recibe la longitud real, en caracteres Unicode, del nombre de ruta de acceso completo.
Otros
 A cambio, el contenido de puszContainerName->Buffer y pcActualLenContainerName no están definidos.

Comentarios

Para obtener una explicación de los conceptos y la terminología de CLFS, consulte Common Log File System.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows Server 2003 R2, Windows Vista y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado wdm.h (incluya Wdm.h)
Library Clfs.lib
Archivo DLL Clfs.sys
IRQL <= APC_LEVEL

Consulte también

ClfsAddLogContainer

ClfsRemoveLogContainer