GetLogContainerName function (clfsw32.h)

Retrieves the full path name of the specified container. This function is used mainly to obtain the full path name of a container referenced in the CLFS_CONTAINER_INFORMATION structure that is returned in calls to ScanLogContainers.

Syntax

CLFSUSER_API BOOL GetLogContainerName(
  [in]                HANDLE            hLog,
  [in]                CLFS_CONTAINER_ID cidLogicalContainer,
  [in, out]           LPCWSTR           pwstrContainerName,
  [in]                ULONG             cLenContainerName,
  [in, out, optional] PULONG            pcActualLenContainerName
);

Parameters

[in] hLog

A handle to the log that is obtained from a successful call to CreateLogFile.

The log handle could refer to a log stream or a physical log.

[in] cidLogicalContainer

The unique identifier that is associated with a container.

[in, out] pwstrContainerName

A pointer to a user-allocated buffer to receive the full path and name of the log container, in wide characters.

[in] cLenContainerName

The size of the buffer pointed to by pwstrContainerName, in characters.

[in, out, optional] pcActualLenContainerName

A pointer to a variable to receive the actual character count of the full container path name that is retrieved.

If the function succeeds, the value of this parameter is less than or equal to cLenContainerName. If the buffer is not large enough to store the whole container path name, the function fails with ERROR_MORE_DATA and sets this parameter to the size that is required for the full path name. For other failures the value is not defined.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero (0). To get extended error information, call GetLastError. The following list identifies the possible error codes:

Requirements

See also

CLFS_CONTAINER_INFORMATION

Common Log File System Functions

ScanLogContainers