FindFiles Class Reference

This class can be used for searching directories for files. It is basically equivalent to the. More...

#include <fileutil.h>

List of all members.

Public Member Functions
	FindFiles ()
BOOL	StartFindingFiles (String_256 *FileSpecifier)
	Scans a given directory for files matching a particular name. Same as FileUtil::StartFindingFiles but being a class is re-entrant and returns directories so that you can do recursive searches.
BOOL	FindNextFile (String_256 *FoundFile, BOOL *IsDirectory)
	Finds the next file, if any. See StartFindingFiles for example search code Notes: ** Note that this will not return system/hidden files **.
BOOL	StopFindingFiles ()
	Stops a directory scan To find files, do something like the following See StartFindingFiles for example search code DO NOT CALL THIS FUNCTION if StartFindingFiles failed. Call this function exactly once for each call to StartFindingFiles.
Private Member Functions
	CC_DECLARE_MEMDUMP (FindFiles)
Private Attributes
String_256	m_SearchPath

---

Detailed Description

This class can be used for searching directories for files. It is basically equivalent to the.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

09/01/97

See also:

Definition at line 179 of file fileutil.h.

---

Constructor & Destructor Documentation

FindFiles::FindFiles (   )  [inline]

Definition at line 184 of file fileutil.h. {};

---

Member Function Documentation

FindFiles::CC_DECLARE_MEMDUMP (  FindFiles   )  [private]

BOOL FindFiles::FindNextFile (  String_256 *  FoundFile, BOOL *  IsDirectory )

Finds the next file, if any. See StartFindingFiles for example search code Notes: ** Note that this will not return system/hidden files **. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> based on Jason code. Date: 12/9/96 Parameters: if  return value is TRUE [OUTPUTS] FoundFile will be filled in with the LEAF filename ("bob.xar") of a found IsDirectory will be TRUE if the file is a directory, else FALSE, if return value is FALSE FoundFile will be set to an empty string. IsDirectory will be FALSE. Returns: TRUE if it found a(nother) file matching the filespec. FALSE if there are no (more) matching files See also: FindFiles::StartFindingFiles; FindFiles::StopFindingFiles FileUtil::StartFindingFiles FileUtil::FindNextFile; FileUtil::StopFindingFiles Definition at line 771 of file fileutil.cpp. { ERROR3IF(FoundFile == NULL || IsDirectory == NULL, "Illegal NULL param"); BOOL result = TRUE; while (result) { if (m_SearchHandle == INVALID_HANDLE_VALUE) { // find first m_SearchHandle = ::FindFirstFile((TCHAR *)m_SearchPath, &m_SearchData); result = (m_SearchHandle != INVALID_HANDLE_VALUE); } else { // find next result = ::FindNextFile(m_SearchHandle, &m_SearchData); } if (result) { // Only return "files" which are not system or hidden const DWORD AttrMask = FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM; const DWORD AttrDirMask = FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM; TCHAR * ThisDir = "."; TCHAR * ParentDir = ".."; INT32 len = camStrclen(m_SearchData.cFileName); if ((m_SearchData.dwFileAttributes & AttrMask) == 0) { // OK, it's a safe file to return, so return it *FoundFile = m_SearchData.cFileName; *IsDirectory = FALSE; return TRUE; } else if (((m_SearchData.dwFileAttributes & AttrDirMask) == 0) && // (cc_lstrncmp(m_SearchData.cFileName, ThisDir, len) != 0) && // (cc_lstrncmp(m_SearchData.cFileName, ParentDir, len) != 0)) (camStrncmp(m_SearchData.cFileName, ThisDir, len) != 0) && (camStrncmp(m_SearchData.cFileName, ParentDir, len) != 0)) { // OK, it's a safe directory to return, so return it *FoundFile = m_SearchData.cFileName; *IsDirectory = TRUE; return TRUE; } } } *FoundFile = TEXT(""); *IsDirectory = FALSE; return FALSE; }

BOOL FindFiles::StartFindingFiles (  String_256 *  FileSpecifier  )

Scans a given directory for files matching a particular name. Same as FileUtil::StartFindingFiles but being a class is re-entrant and returns directories so that you can do recursive searches. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> based on Jason code. Date: 9/1/97 Parameters: FileSpecifier  - A full pathname specifying the file(s) to search for. [INPUTS] You may include ? and * wildcards For example, c:.xar one specific file c:\*.txt all .txt files c:\*.* all files Returns: TRUE if the scan was successfully started, FALSE otherwise See also: FindFiles::FindNextFile; FindFiles::StopFindingFiles FileUtil::StartFindingFiles FileUtil::FindNextFile; FileUtil::StopFindingFiles Definition at line 738 of file fileutil.cpp. { ERROR3IF(FileSpecifier == NULL, "Duff FileSpecifier param"); m_SearchHandle = INVALID_HANDLE_VALUE; m_SearchPath = *FileSpecifier; return(TRUE); }

BOOL FindFiles::StopFindingFiles (  void   )

Stops a directory scan To find files, do something like the following See StartFindingFiles for example search code DO NOT CALL THIS FUNCTION if StartFindingFiles failed. Call this function exactly once for each call to StartFindingFiles. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> based on Jason code. Date: 12/9/96 Returns: True if completed ok, False otherwise. See also: FindFiles::StartFindingFiles; FindFiles::FindNextFile FileUtil::StartFindingFiles FileUtil::FindNextFile; FileUtil::StopFindingFiles Definition at line 843 of file fileutil.cpp. { if (m_SearchHandle != NULL) ::FindClose(m_SearchHandle); m_SearchHandle = INVALID_HANDLE_VALUE; return TRUE; }

---

Member Data Documentation

String_256 FindFiles::m_SearchPath [private]

Definition at line 192 of file fileutil.h.

---

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

• wxOil/fileutil.h (r1785/r1461)
• wxOil/fileutil.cpp (r1785/r1482)

---