Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members
irr::io::IFileList

irr::io::IFileList Class Reference

The Filelist lists all files in a directory. More...

#include <IFileList.h>

Inheritance diagram for irr::io::IFileList:

irr::IReferenceCounted List of all members.

Public Member Functions

virtual u32 getFileCount () const =0
 Get the number of files in the filelist.
virtual const c8 * getFileName (u32 index) const =0
 Gets the name of a file in the list, based on an index.
virtual const c8 * getFullFileName (u32 index)=0
 Gets the full name of a file in the list, path included, based on an index.
virtual bool isDirectory (u32 index) const =0
 Returns of the file is a directory.
virtual ~IFileList ()
 Destructor.

Detailed Description

The Filelist lists all files in a directory.

Definition at line 16 of file IFileList.h.

Constructor & Destructor Documentation

virtual irr::io::IFileList::~IFileList (   )  [inline, virtual]
 

Destructor.

Definition at line 21 of file IFileList.h.

Member Function Documentation

virtual u32 irr::io::IFileList::getFileCount (   )  const [pure virtual]
 

Get the number of files in the filelist.

Returns:
Amount of files and directories in the file list.

virtual const c8* irr::io::IFileList::getFileName (  u32  index  )  const [pure virtual]
 

Gets the name of a file in the list, based on an index.

The path is not included in this name. Use getFullFileName for this.

Parameters:
index is the zero based index of the file which name should be returned. The index has to be smaller than the amount getFileCount() returns.
Returns:
File name of the file. Returns 0, if an error occured.

virtual const c8* irr::io::IFileList::getFullFileName (  u32  index  )  [pure virtual]
 

Gets the full name of a file in the list, path included, based on an index.

Parameters:
index is the zero based index of the file which name should be returned. The index has to be smaller than the amount getFileCount() returns.
Returns:
File name of the file. Returns 0, if an error occured.

virtual bool irr::io::IFileList::isDirectory (  u32  index  )  const [pure virtual]
 

Returns of the file is a directory.

Parameters:
index is the zero based index of the file which name should be returned. The index has to be smaller than the amount getFileCount() returns.
Returns:
True, if the file is a directory, and false, if it is not. If an error occurs, the result is undefined.

The documentation for this class was generated from the following file:
The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2008 by Nikolaus Gebhardt. Generated on Sun Sep 21 08:57:54 2008 by Doxygen (1.4.2)