ClfsGetContainerName - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers 
// wdm.h

CLFSUSER_API NTSTATUS ClfsGetContainerName(
  [in]            PLOG_FILE_OBJECT  plfoLog,
  [in]            CLFS_CONTAINER_ID cidLogicalContainer,
  [out]           PUNICODE_STRING   puszContainerName,
  [out, optional] PULONG            pcActualLenContainerName
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Edit description on GitHub

Windows Driver Kit DDI reference (nf-wdm-clfsgetcontainername)

ClfsGetContainerName function

Description

The ClfsGetContainerName routine returns the path name of a specified container.

Parameters

plfoLog [in]

A pointer to a LOG_FILE_OBJECT structure that represents a CLFS log. The caller previously obtained this pointer by calling ClfsCreateLogFile.

cidLogicalContainer [in]

The logical identifier of a container in the CLFS log.

puszContainerName [out]

A pointer to a UNICODE_STRING structure. The Buffer member of puszContainerName must point to a caller-allocated buffer that receives the path name of the container. The MaximumLength member must supply the size of the buffer.

pcActualLenContainerName [out, optional]

A pointer to a ULONG-typed variable that receives the actual length, in Unicode characters, of the container's path name. This parameter can be NULL.

Return value

ClfsGetContainerName returns one of the status codes defined in Ntstatus.h. The following table gives the meanings of various return values.

Return code Description
STATUS_SUCCESS The Buffer member of puszContainerName receives the full path name of the container. If pcActualLenContainerName is not NULL, it receives the actual length, in Unicode characters, of the full path name.
STATUS_BUFFER_OVERFLOW The actual length, in Unicode characters, of the full path name is larger than puszContainerName->MaximumLength. The Buffer member of puszContainerName receives the full path name of the container truncated to the number of characters specified by puszContainerName->MaximumLength. If pcActualLenContainerName is not NULL, it receives the actual length, in Unicode characters, of the full path name.
Other On return, the contents of puszContainerName->Buffer and pcActualLenContainerName are undefined.

Remarks

For an explanation of CLFS concepts and terminology, see Common Log File System.

See also

ClfsAddLogContainer

ClfsRemoveLogContainer

View the official Windows Driver Kit DDI reference

Edit description on GitHub