IPlatformFile::FileJournalIterateDirectory

Navigation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/IPlatformFile

Description

Iterate the given directory as with IterateDirectoryStat, but report a FFileJournalData for each file and directory, which notably includes the FFileJournalFileHandle for the file/directory.

The paths returned as the first argument of the visitor function are the combined paths produced by combining the input directory with the relative path of the child file or directory.

If the FileJournal is unavailable on the current system the iteration will still succeed but the FFileJournalFileHandle for each child path will be set to FileJournalFileHandleInvalid.

If the FileJournal is available on the current system but not on the volume of the given directory, it is arbitrary whether the FFileJournalFileHandle will be validly set; if not valid they will be set to FileJournalFileHandleInvalid.

Derived Overrides

• FCachedReadPlatformFile::FileJournalIterateDirectory
• FLoggedPlatformFile::FileJournalIterateDirectory
• FPlatformFileOpenLog::FileJournalIterateDirectory

virtual bool FileJournalIterateDirectory  
(  
    const TCHAR * Directory,  
    FDirectoryJournalVisitorFunc Visitor,  
    FString * OutError  
)  
Copy full snippet

virtual bool FileJournalIterateDirectory (     const TCHAR * Directory,     FDirectoryJournalVisitorFunc Visitor,     FString * OutError )

false if the directory did not exist or if the visitor returned false.