C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

FileEntry Class Reference
[recls.c++]

This class represents a file search entry. More...

#include <fileentry.hpp>

List of all members.

State

 operator boolean_type () const
 Indicates the state of the instance, i.e. whether it is contains a valid recls_info_t or not.

bool operator! () const
 Returns the logical inverse of the state of the instance, i.e. whether it is contains a valid recls_info_t or not.


Public Types

typedef recls_char_t char_type
typedef FileEntry class_type

Public Methods

Construction
 FileEntry ()
 Default constructor.

 FileEntry (FileEntry const &rhs)
 Copy constructor.

 ~FileEntry ()
 Destructor.

FileEntry & operator= (FileEntry const &rhs)
 Copy assignment operator.

Attributes
char_type const * c_str () const
 Returns a pointer to the full path of the file entry, or the empty string.

string_t GetPath () const
 Returns the full path of the file entry.

string_t GetDirectory () const
 Returns the directory of the file entry.

string_t GetDirectoryPath () const
 Returns the directory (+ drive) of the file entry.

string_t GetUNCDrive () const
 Returns the UNC drive component, if any, of the file entry's path.

DirectoryParts GetDirectoryParts () const
 Returns the directory parts of the file entry.

string_t GetFile () const
 Returns the file (filename + extension) of the file entry.

string_t GetShortFile () const
 Returns the short form of the file (filename + extension) of the file entry.

string_t GetFileName () const
 Returns the filename of the file entry.

string_t GetFileExt () const
 Returns the file extension of the file entry.

recls_time_t GetCreationTime () const
 Returns the creation time of the file entry.

recls_time_t GetModificationTime () const
 Returns the modification time of the file entry.

recls_time_t GetLastAccessTime () const
 Returns the last access time of the file entry.

recls_time_t GetLastStatusChangeTime () const
 Returns the last statuc change time of the file entry.

recls_filesize_t GetSize () const
 Returns the size of the file entry.

recls_bool_t IsReadOnly () const
 Indicates whether the file entry is read-only.

recls_bool_t IsDirectory () const
 Indicates whether the file entry is a directory.

recls_bool_t IsLink () const
 Indicates whether the file entry is a link.

recls_bool_t IsUNC () const
 Indicates whether the file entry's path is UNC.


Detailed Description

This class represents a file search entry.


Member Typedef Documentation

typedef recls_char_t char_type
 

typedef FileEntry class_type
 


Constructor & Destructor Documentation

FileEntry   [inline]
 

Default constructor.

FileEntry FileEntry const &    rhs [inline]
 

Copy constructor.

~FileEntry   [inline]
 

Destructor.


Member Function Documentation

FileEntry::char_type const * c_str   [inline]
 

Returns a pointer to the full path of the file entry, or the empty string.

recls_time_t GetCreationTime   [inline]
 

Returns the creation time of the file entry.

\Note On systems other than Win32, this is identical to GetModificationTime()

string_t GetDirectory   [inline]
 

Returns the directory of the file entry.

DirectoryParts GetDirectoryParts   [inline]
 

Returns the directory parts of the file entry.

string_t GetDirectoryPath   [inline]
 

Returns the directory (+ drive) of the file entry.

string_t GetFile   [inline]
 

Returns the file (filename + extension) of the file entry.

string_t GetFileExt   [inline]
 

Returns the file extension of the file entry.

string_t GetFileName   [inline]
 

Returns the filename of the file entry.

recls_time_t GetLastAccessTime   [inline]
 

Returns the last access time of the file entry.

recls_time_t GetLastStatusChangeTime   [inline]
 

Returns the last statuc change time of the file entry.

\Note On systems other than UNIX, this is identical to GetModificationTime()

recls_time_t GetModificationTime   [inline]
 

Returns the modification time of the file entry.

string_t GetPath   [inline]
 

Returns the full path of the file entry.

string_t GetShortFile   [inline]
 

Returns the short form of the file (filename + extension) of the file entry.

\Note On systems other than Win32, this is identical to GetFile()

recls_filesize_t GetSize   [inline]
 

Returns the size of the file entry.

string_t GetUNCDrive   [inline]
 

Returns the UNC drive component, if any, of the file entry's path.

recls_bool_t IsDirectory   [inline]
 

Indicates whether the file entry is a directory.

recls_bool_t IsLink   [inline]
 

Indicates whether the file entry is a link.

recls_bool_t IsReadOnly   [inline]
 

Indicates whether the file entry is read-only.

recls_bool_t IsUNC   [inline]
 

Indicates whether the file entry's path is UNC.

operator boolean_type   const [inline]
 

Indicates the state of the instance, i.e. whether it is contains a valid recls_info_t or not.

bool operator!   [inline]
 

Returns the logical inverse of the state of the instance, i.e. whether it is contains a valid recls_info_t or not.

FileEntry & operator= FileEntry const &    rhs [inline]
 

Copy assignment operator.


Friends And Related Function Documentation

friend class Search [friend]
 


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

recls Library documentation Synesis Software Pty Ltd, 2001-2005