GDirectory Class Reference

Generic directory iterator. More...

#include <GFile.h>

Inheritance diagram for GDirectory:

GDirImpl

List of all members.

Public Member Functions

virtual int First (char *Name, char *Pattern=LGI_ALL_FILES)=0
 Starts the search. The entries '.' and '..' are never returned. The default pattern returns all files.
virtual int Next ()=0
 Get the next match.
virtual int Close ()=0
 Finish the search.
virtual bool Path (char *s, int BufSize)=0
 Constructs the full path of the current directory entry.
virtual long GetAttributes ()=0
 Gets the current entries attributes (platform specific).
virtual char * GetName ()=0
 Gets the name of the current entry. (Doesn't include the path).
virtual int GetUser (bool Group)=0
 Gets the user id of the current entry. (Doesn't have any meaning on Win32).
virtual const uint64 GetCreationTime ()=0
 Gets the entries creation time. You can convert this to an easy to read for using GDateTime.
virtual const uint64 GetLastAccessTime ()=0
 Gets the entries last access time. You can convert this to an easy to read for using GDateTime.
virtual const uint64 GetLastWriteTime ()=0
 Gets the entries last modified time. You can convert this to an easy to read for using GDateTime.
virtual const uint64 GetSize ()=0
 Returns the size of the entry.
virtual bool IsDir ()=0
 Returns true if the entry is a sub-directory.
virtual bool IsReadOnly ()=0
 Returns true if the entry is read only.
virtual bool IsHidden ()=0
 Returns true if the entry is hidden. This is equivilant to a attribute flag on win32 and a leading '.' on unix.
virtual GDirectoryClone ()=0
 Creates an copy of this type of GDirectory class.
virtual int GetType ()=0
 Gets the type code of the current entry. See the VT_?? defines for possible values.
bool ConvertToTime (char *Str, uint64 Time)
 Converts a string to the 64-bit value returned from the date functions.
bool ConvertToDate (char *Str, uint64 Time)
 Converts the 64-bit value returned from the date functions to a string.


Detailed Description

Generic directory iterator.

Member Function Documentation

virtual int GDirectory::Close (  )  [pure virtual]

Finish the search.

Returns:
Non zero on success

Implemented in GDirImpl.

virtual int GDirectory::First ( char *  Name,
char *  Pattern = LGI_ALL_FILES 
) [pure virtual]

Starts the search. The entries '.' and '..' are never returned. The default pattern returns all files.

Returns:
Non zero on success
Parameters:
Name  The path of the directory
Pattern  The pattern to match files against.
See also:
The default LGI_ALL_FILES matchs all files.

Implemented in GDirImpl.

Referenced by LgiRecursiveFileSearch(), SystemFunctions::ListFiles(), and GFileSystem::RemoveDirectory().

virtual int GDirectory::GetUser ( bool  Group  )  [pure virtual]

Gets the user id of the current entry. (Doesn't have any meaning on Win32).

Parameters:
Group  If true gets the group id instead of the user id.

Implemented in GDirImpl.

virtual int GDirectory::Next (  )  [pure virtual]

Get the next match.

Returns:
Non zero on success

Implemented in GDirImpl.

Referenced by LgiRecursiveFileSearch(), SystemFunctions::ListFiles(), and GFileSystem::RemoveDirectory().

virtual bool GDirectory::Path ( char *  s,
int  BufSize 
) [pure virtual]

Constructs the full path of the current directory entry.

Returns:
Non zero on success

Implemented in GDirImpl.

Referenced by LgiRecursiveFileSearch(), and GFileSystem::RemoveDirectory().


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

Generated on Wed Dec 1 15:41:02 2010 for Lgi by  doxygen 1.5.7.1