MiKTeX 23.10-next
A scalable TeX distribution
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
MiKTeX::Core::DirectoryLister Class Referenceabstract

An instances can be used to read entries of a file system directory. More...

#include <miktex/Core/DirectoryLister.h>

Public Types

enum class  Options : int { None , DirectoriesOnly = 1 , FilesOnly = 2 , IncludeDotAndDotDot = 4 }
 Read options. More...
 

Public Member Functions

virtual void Close ()=0
 Dispose resources associated with this object. More...
 
virtual bool GetNext (DirectoryEntry &direntry)=0
 
virtual bool GetNext (DirectoryEntry2 &direntry2)=0
 

Static Public Member Functions

static std::unique_ptr< DirectoryListerOpen (const MiKTeX::Util::PathName &directory)
 
static std::unique_ptr< DirectoryListerOpen (const MiKTeX::Util::PathName &directory, const char *pattern)
 
static std::unique_ptr< DirectoryListerOpen (const MiKTeX::Util::PathName &directory, const char *pattern, int options)
 

Detailed Description

An instances can be used to read entries of a file system directory.

Member Enumeration Documentation

◆ Options

enum class MiKTeX::Core::DirectoryLister::Options : int
strong

Read options.

Enumerator
DirectoriesOnly 

Read directory entries only.

FilesOnly 

Read file entries only.

IncludeDotAndDotDot 

Include . and .. in result.

Member Function Documentation

◆ Close()

virtual void MiKTeX::Core::DirectoryLister::Close ( )
pure virtual

Dispose resources associated with this object.

◆ GetNext() [1/2]

virtual bool MiKTeX::Core::DirectoryLister::GetNext ( DirectoryEntry direntry)
pure virtual

Gets the next entry.

Parameters
[out]Thenext entry.
Returns
Returns true, if the next entry could be retrieved. Returns false, if there are no more entries.

◆ GetNext() [2/2]

virtual bool MiKTeX::Core::DirectoryLister::GetNext ( DirectoryEntry2 direntry2)
pure virtual

Gets the next entry.

Parameters
[out]Thenext entry.
Returns
Returns true, if the next entry could be retrieved. Returns false, if there are no more entries.

◆ Open() [1/3]

static std::unique_ptr< DirectoryLister > MiKTeX::Core::DirectoryLister::Open ( const MiKTeX::Util::PathName directory)
static

Creates a new DirectoryLister instance.

Parameters
directoryFile system path to the directory.
Returns
Returns a smart pointer to the DirectoryLister interface.

◆ Open() [2/3]

static std::unique_ptr< DirectoryLister > MiKTeX::Core::DirectoryLister::Open ( const MiKTeX::Util::PathName directory,
const char *  pattern 
)
static

Creates a new DirectoryLister instance.

Parameters
directoryFile system path to the directory.
patternThe glob pattern to be used as the filter.
Returns
Returns a smart pointer to the DirectoryLister interface.

◆ Open() [3/3]

static std::unique_ptr< DirectoryLister > MiKTeX::Core::DirectoryLister::Open ( const MiKTeX::Util::PathName directory,
const char *  pattern,
int  options 
)
static

Creates a new DirectoryLister instance.

Parameters
directoryFile system path to the directory.
patternThe glob pattern to be used as the filter.
optionsRead options.
Returns
Returns a smart pointer to the DirectoryLister interface.

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