Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
IPlatformFile::FDirectoryVisitor Class Referenceabstract

#include <GenericPlatformFile.h>

+ Inheritance diagram for IPlatformFile::FDirectoryVisitor:

Public Member Functions

 FDirectoryVisitor (EDirectoryVisitorFlags InDirectoryVisitorFlags=EDirectoryVisitorFlags::None)
 
virtual ~FDirectoryVisitor ()
 
virtual bool Visit (const TCHAR *FilenameOrDirectory, bool bIsDirectory)=0
 
FORCEINLINE bool IsThreadSafe () const
 

Public Attributes

EDirectoryVisitorFlags DirectoryVisitorFlags
 

Detailed Description

Base class for file and directory visitors that take only the name.

Definition at line 353 of file GenericPlatformFile.h.

Constructor & Destructor Documentation

◆ FDirectoryVisitor()

IPlatformFile::FDirectoryVisitor::FDirectoryVisitor ( EDirectoryVisitorFlags InDirectoryVisitorFlags = EDirectoryVisitorFlags::None)
inline

Definition at line 356 of file GenericPlatformFile.h.

◆ ~FDirectoryVisitor()

virtual IPlatformFile::FDirectoryVisitor::~FDirectoryVisitor ( )
inlinevirtual

Definition at line 361 of file GenericPlatformFile.h.

Member Function Documentation

◆ IsThreadSafe()

FORCEINLINE bool IPlatformFile::FDirectoryVisitor::IsThreadSafe ( ) const
inline

True if the Visit function can be called from multiple threads at once.

Definition at line 372 of file GenericPlatformFile.h.

◆ Visit()

virtual bool IPlatformFile::FDirectoryVisitor::Visit ( const TCHAR * FilenameOrDirectory,
bool bIsDirectory )
pure virtual

Callback for a single file or a directory in a directory iteration.

Parameters
FilenameOrDirectoryIf bIsDirectory is true, this is a directory (with no trailing path delimiter), otherwise it is a file name.
bIsDirectorytrue if FilenameOrDirectory is a directory.
Returns
true if the iteration should continue.

Implemented in FLocalTimestampDirectoryVisitor, and FLoggedPlatformFile::FLogVisitor.

+ Here is the caller graph for this function:

Member Data Documentation

◆ DirectoryVisitorFlags

EDirectoryVisitorFlags IPlatformFile::FDirectoryVisitor::DirectoryVisitorFlags

Definition at line 377 of file GenericPlatformFile.h.

The documentation for this class was generated from the following file: