---

WWhizFileList Class Reference

Represents a file list, usually sorted. More...

#include <WWhizInterface2.h>

List of all members.

Public Methods
virtual int	GetCount (void)const=0
virtual WWhizFile*	Get (int index)const=0
virtual WWhizFile*	Find (CString fullName)const=0
	Searches for a file matching [fullName]. More...
virtual int	FindExact (WWhizFile &file)const=0
	Based on an existing WWhizFile, FindExact() finds the index corresponding to that file. More...
virtual int	FindNext (int startPos,WWhizFile &file)const=0
	Based on an existing WWhizFile, FindExact() finds the next index corresponding to an approximate file match. More...
virtual int	FindPrevious (int startPos,WWhizFile &file)const=0
	Based on an existing WWhizFile, FindPrevious() finds the previous index corresponding to an approximate file match. More...
virtual WWhizFile&	Create (const CString &filename)=0
	Based on a filename, Create() returns a new WWhizFile object that has a reference count of 1. More...

---

Detailed Description

Represents a file list, usually sorted.

Only contains unique filenames.

---

Member Function Documentation

WWhizFile & WWhizFileList::Create ( const CString & filename ) [pure virtual]

Based on a filename, Create() returns a new WWhizFile object that has a reference count of 1. The application is responsible for calling Release() on the file when done. Parameters: filename   The filename to create a WWhizFile object from. Returns: A WWhizFile describing [filename].

WWhizFile * WWhizFileList::Find ( CString fullName ) const [pure virtual]

Searches for a file matching [fullName]. Parameters: fullName   The full path name of the file to find, case sensitive. Returns: Returns the WWhizFile of the found file. If the file was not found, returns NULL.

int WWhizFileList::FindExact ( WWhizFile & file ) const [pure virtual]

Based on an existing WWhizFile, FindExact() finds the index corresponding to that file. Parameters: An   existing WWhizFile, obtained via WWhizFileList::Get() or WWhizFileList::Create(). Returns: Returns the found index or -1 if not found.

int WWhizFileList::FindNext ( int startPos, WWhizFile & file ) const [pure virtual]

Based on an existing WWhizFile, FindExact() finds the next index corresponding to an approximate file match. Parameters: An   existing WWhizFile, obtained via WWhizFileList::Get() or WWhizFileList::Create(). Returns: Returns the found index or -1 if not found.

int WWhizFileList::FindPrevious ( int startPos, WWhizFile & file ) const [pure virtual]

Based on an existing WWhizFile, FindPrevious() finds the previous index corresponding to an approximate file match. Parameters: An   existing WWhizFile, obtained via WWhizFileList::Get() or WWhizFileList::Create(). Returns: Returns the found index or -1 if not found.

WWhizFile * WWhizFileList::Get ( int index ) const [pure virtual]

Parameters: index   The index of the WWhizFile to retrieve. Returns: Retrieves the file at [index].

int WWhizFileList::GetCount ( void ) const [pure virtual]

Returns: Retrieves the count of files in the file list.

---

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

• WWhizInterface2.h

---