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.
CLFSUSER_API BOOL GetLogContainerName( IN HANDLE hLog, IN CLFS_CONTAINER_ID cidLogicalContainer, IN OUT LPCWSTR pwstrContainerName, IN ULONG cLenContainerName, IN OUT PULONG pcActualLenContainerName );
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.
The unique identifier that is associated with a container.
A pointer to a user-allocated buffer to receive the full path and name of the log container, in wide characters.
The size of the buffer pointed to by pwstrContainerName, in characters.
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.
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:
|Minimum supported client||Windows Vista [desktop apps only]|
|Minimum supported server||Windows Server 2003 R2 [desktop apps only]|