GetLogContainerName

GetLogContainerName function

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


BOOL WINAPI GetLogContainerName(
  _In_        HANDLE            hLog,
  _In_        CLFS_CONTAINER_ID cidLogicalContainer,
  _Inout_     LPCWSTR           pwstrContainerName,
  _In_        ULONG             cLenContainerName,
  _Inout_opt_ PULONG            pcActualLenContainerName
);

Parameters

hLog [in]

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.

cidLogicalContainer [in]

The unique identifier that is associated with a container.

pwstrContainerName [in, out]

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

cLenContainerName [in]

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

pcActualLenContainerName [in, out, optional]

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:

ERROR_ACCESS_DENIED
ERROR_INVALID_HANDLE
ERROR_INVALID_PARAMETER
ERROR_MORE_DATA

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Header

Clfsw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

CLFS_CONTAINER_INFORMATION
Common Log File System Functions
ScanLogContainers

 

 

Community Additions

ADD
Show:
© 2016 Microsoft