FileUtil Class Reference

This class contains a library of static functions for use on Windows platforms. The functions perform general file manipulation operations, rather than single file data IO. If you want the size of a file, to locate a particular file on disc etc, then here's where you'll find all those useful routines to do it. More...

#include <fileutil.h>

List of all members.

Static Public Member Functions
static BOOL	FindResourceFile (TCHAR *SearchFile, TCHAR *FoundFile)
	The function searches for a matching file in the following directories in the following sequence: 1. The directory from which the application loaded. 2. The current directory. 3. Windows 95: The Windows system directory. Windows NT: The 32-bit Windows system directory. 4. Windows NT only: The 16-bit Windows system directory. 5. The Windows directory. 6. The directories that are listed in the PATH environment variable.
static BOOL	StartFindingFiles (String_256 *FileSpecifier)
	Scans a given directory for files matching a particular name.
static BOOL	FindNextFile (String_256 *FoundFile)
	Finds the next file, if any. See StartFindingFiles for example search code.
static void	StopFindingFiles (void)
	Stops a directory scan.
static BOOL	GetLongFileName (LPTSTR lpszPath, LPTSTR lpszOutput, size_t cchMaxOutLen)
	Given a full 8.3 pathname, extract the full filename.
static UINT32	GetTemporaryFileName (const TCHAR *PathName, const TCHAR *Prefix, UINT32 Unique, TCHAR *FileName)
	Creates a unique file name to be used as temporary file. The format of the file name is path.TMP, where 'path' is specified by PathName, 'pre' are the first three characters pointed by Prefix, 'uuuu' is the hexadecimal Unique parameter. Pass 0 for Unique to be certain the temp file name is really unique.
static DWORD	GetTemporaryPath (UINT32 BufferLength, TCHAR *Buffer)
	Gets the temporary directory.
static PathName	GetTemporaryPathName ()
	Simplified interface to GetTempFileName().
static BOOL	GetTemporaryPathName (const TCHAR *pExt, PathName *pTempPath)
	Simplified interface to GetTempFileName(). Call this function when you want to create a new temporary file with a particular extension.
static BOOL	DeleteFile (PathName *FileToRemove)
	Removes a file.
static BOOL	GetCurrentDirectory (String_256 *pCurrentPath)
	Set up the operating system current directory.
static BOOL	SetCurrentDirectory (const PathName &NewCurrentPath)
	Set up the operating system current directory.
static BOOL	SetCurrentDirectory (const String_256 &NewCurrentPath)
	Set up the operating system current directory.
static BOOL	RecursiveCreateDirectory (const String_256 &strDirPath)
	Recursivly create directory path.
static DWORD	FindFileAttributes (LPCTSTR lpFileName)
Static Private Attributes
static BOOL	SearchActive = FALSE
static bool	s_fStarted = false
static String_256	SearchPath = TEXT("")
static wxDir	s_dirSearch

---

Detailed Description

This class contains a library of static functions for use on Windows platforms. The functions perform general file manipulation operations, rather than single file data IO. If you want the size of a file, to locate a particular file on disc etc, then here's where you'll find all those useful routines to do it.

Author:

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

Date:

24/07/96

See also:

Definition at line 123 of file fileutil.h.

---

Member Function Documentation

BOOL FileUtil::DeleteFile (  PathName *  FileToRemove  )  [static]

Removes a file. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> (based on code by Neville Humphrys) Date: 11/4/97 Parameters: FileToRemove  - the path name of the file to be removed. [INPUTS] Returns: TRUE if succesful, FALSE otherwise Definition at line 573 of file fileutil.cpp. { if (FileToRemove == NULL) return FALSE; BOOL Exists = TRUE; BOOL status = TRUE; // check if the file exists Exists = SGLibOil::FileExists(FileToRemove); // remove it if (Exists) status = wxRemoveFile( FileToRemove->GetPath() ); return !status; }

static DWORD FileUtil::FindFileAttributes (  LPCTSTR  lpFileName  )  [inline, static]

Definition at line 150 of file fileutil.h. { TRACE( wxT("Warning - FileUtil::FindFileAttributes called\n") ); #if defined(__WXMSW__) return GetFileAttributes( lpFileName ); #else return 0; #endif }

BOOL FileUtil::FindNextFile (  String_256 *  FoundFile  )  [static]

Finds the next file, if any. See StartFindingFiles for example search code. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/96 Parameters: If  return value is TRUE, FoundFile will be filled in with [OUTPUTS] the LEAF filename ("bob.xar") of a found file - else, it will be set to an empty string. (I was going to return a PathName - it seemed logical - but.... An attempt to set the location/path ("c:\directory") followed by the leaf-name ("bob.xar") resulted in a PathName of "bob.xar.xar" as opposed to "c:\directory\bob.xar". Returns: TRUE if it found a(nother) file matching the filespec. FALSE if there are no (more) matching files Notes: ** Note that this will not return system/hidden files or directories ** See also: FileUtil::StartFindingFiles; FileUtil::StopFindingFiles Definition at line 268 of file fileutil.cpp. { ERROR3IF(FoundFile == NULL, "Illegal NULL param"); if (!SearchActive) { ERROR3("FindNextFile called when StartFindingFiles not called/failed"); return(FALSE); } BOOL result = TRUE; while (result) { wxString strFileName; if( !s_fStarted ) { // find first PathName path( SearchPath ); result = wxDir::Exists( path.GetLocation() ); result = result && s_dirSearch.Open( path.GetLocation() ); result = result && s_dirSearch.GetFirst( &strFileName, (PCTSTR)path.GetFileName(), wxDIR_FILES ); s_fStarted = result; } else { // find next result = s_dirSearch.GetNext( &strFileName ); } if (result) { PORTNOTE("other", "This is part of initial GetFirst" ) #if !defined(EXCLUDE_FROM_XARALX) // Only return "files" which are not system or hidden, and which aren't directories! const DWORD AttrMask = FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_HIDDEN | FILE_ATTRIBUTE_SYSTEM; if ((SearchData.dwFileAttributes & AttrMask) == 0) #endif { // OK, it's a safe file to return, so return it *FoundFile = (PCTSTR)strFileName; return(TRUE); } } } *FoundFile = TEXT(""); return(FALSE); }

BOOL FileUtil::FindResourceFile (  TCHAR *  SearchFile, TCHAR *  FoundFile )  [static]

The function searches for a matching file in the following directories in the following sequence: 1. The directory from which the application loaded. 2. The current directory. 3. Windows 95: The Windows system directory. Windows NT: The 32-bit Windows system directory. 4. Windows NT only: The 16-bit Windows system directory. 5. The Windows directory. 6. The directories that are listed in the PATH environment variable. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 8/5/96 Parameters: SearchFile  = the name of the file to search for [INPUTS] FoundFile  = the pathname of the first file to match SearchFile. [OUTPUTS] Returns: TRUE if the file has been found FALSE if not Definition at line 142 of file fileutil.cpp. { // Try to find the printer.cms file BOOL Found = FALSE; #if WIN16 // 16 bit Windows - look in the PATH variable and current // directory using _searchenv. _tsearchenv((char*)SearchFile, "PATH", (char*)FoundFile); Found = (FoundFile[0] != '\0'); #else // 32-bit Windows - use Win32 API SearchPath, which will look in all kinds // of places, and hopefully should find the 16-bit Windows directory if it's // on the user's path, and use the ini file in there. LPTSTR FirstChar; DWORD BytesRead = ::SearchPath(NULL, // Use default search paths (see help file) SearchFile, NULL, // Filename already has an extension _MAX_PATH - 1, // Destination buffer size FoundFile, // Destination buffer &FirstChar); Found = (BytesRead > 0) && (BytesRead < _MAX_PATH); #endif return Found; }

BOOL FileUtil::GetCurrentDirectory (  String_256 *  pCurrentPath  )  [static]

Set up the operating system current directory. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 31/10/97 Parameters: NewCurrentPath  - the new current path to be used. [INPUTS] Returns: TRUE if succesful, FALSE otherwise Definition at line 645 of file fileutil.cpp. { ERROR2IF(pCurrentPath == NULL,FALSE,"FileUtil::GetCurrentDirectory Bad params"); // Call the OS to get the new current directory // DWORD nBufferLength size, in characters, of directory buffer // LPTSTR lpBuffer address of buffer for current directory // If the function succeeds, the return value specifies the number of characters // written to the buffer, not including the terminating null character. // If the function fails, the return value is zero. const INT32 MaxSize = 256; TCHAR Buffer[MaxSize]; DWORD chars = ::GetCurrentDirectory( MaxSize, Buffer); if (chars > 0) { *pCurrentPath = Buffer; } else pCurrentPath->Empty(); return (chars > 0); }

BOOL FileUtil::GetLongFileName (  LPTSTR  lpszPath, LPTSTR  lpszOutput, size_t  cchMaxOutLen )  [static]

Given a full 8.3 pathname, extract the full filename. Author: Richard_Millican (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: lpszPath  the full pathname of the file (short, or long) [INPUTS] cchMaxLen the size of the output buffer (if not big enough, we WILL fail and return FALSE) lpszOutput  contains the full, long, filename of the file [OUTPUTS] Returns: TRUE if successful, FALSE otherwise. Errors: - See also: MakeShortPath (which is currently in helpuser.cpp for some bizarre reason...) Definition at line 371 of file fileutil.cpp. { if(lpszPath == NULL || lpszOutput == NULL || cchMaxOutLen < 1) { ERROR3("FileUtil::GetLongFileName given dodgy params - come on, play the game..."); return FALSE; } WIN32_FIND_DATA FileData; // Perform a search for the specified file HANDLE hSearch = ::FindFirstFile(lpszPath, &FileData); if (hSearch == INVALID_HANDLE_VALUE) { //ERROR3_PF(("FileUtil::GetLongFileName Corresponding long filename version of %s not found", lpszPath)); return FALSE; } // The find_data structure will hopefully now contain the long filename for the file if(camStrlen(FileData.cFileName) < (INT32)cchMaxOutLen) { camStrcpy(lpszOutput, FileData.cFileName); return TRUE; } return FALSE; }

UINT32 FileUtil::GetTemporaryFileName (  const TCHAR *  PathName, const TCHAR *  Prefix, UINT32  Unique, TCHAR *  FileName )  [static]

Creates a unique file name to be used as temporary file. The format of the file name is path.TMP, where 'path' is specified by PathName, 'pre' are the first three characters pointed by Prefix, 'uuuu' is the hexadecimal Unique parameter. Pass 0 for Unique to be certain the temp file name is really unique. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/97 Parameters: pPathName  address of directory name for temporary file [INPUTS] Prefix address of filename prefix Unique number used to create temporary filename FileName  address of buffer that receives the new filename [OUTPUTS] Returns: The unique numeric value used in the temporary filenamem, or 0 if unsuccessful. Errors: - See also: FileUtil::GetTemporaryDir Definition at line 515 of file fileutil.cpp. { if(PathName == NULL || Prefix == NULL || FileName == NULL) { ERROR3("FileUtil::GetTempFileName given dodgy params - come on, play the game..."); return FALSE; } wxString str( PathName ); // str += Prefix; str = wxFileName::CreateTempFileName( str ); camStrcpy( FileName, str.c_str() ); return Unique != 0 ? Unique : 0xD7334; // Random non-zero value }

DWORD FileUtil::GetTemporaryPath (  UINT32  BufferLength, TCHAR *  Buffer )  [static]

Gets the temporary directory. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/97 Parameters: BufferLength  the lenght of the buffer addressed by the second parameter [INPUTS] Buffer  points to a character buffer, to receive the directory name [OUTPUTS] Returns: The actual length of the returned string Errors: - See also: FileUtil::GetTemporaryFileName Definition at line 547 of file fileutil.cpp. { if(Buffer == NULL || BufferLength == 0) { ERROR3("FileUtil::GetTempPath given dodgy params - come on, play the game..."); return FALSE; } return ::GetTempPath(BufferLength, Buffer); }

BOOL FileUtil::GetTemporaryPathName (  const TCHAR *  pExt, PathName *  pTempPath )  [static]

Simplified interface to GetTempFileName(). Call this function when you want to create a new temporary file with a particular extension. Author: Stefan_Stoykov (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/97 Parameters: pExt  - pointer to the extension for the new file [INPUTS] pTempPath  - a path for a new temporary file [OUTPUTS] Returns: TRUE, if successful, FALSE otherwise Errors: - See also: - GetTemporaryPathName() Definition at line 460 of file fileutil.cpp. { ERROR3IF((pTempPath == NULL) || (pExt == NULL), "NULL param passed to FileUtil::GetTemporaryPathName"); if ((pTempPath == NULL) || (pExt == NULL)) return FALSE; // create a new temp file *pTempPath = FileUtil::GetTemporaryPathName(); // if tmp extension is asked - call the relevant function if (camStricmp(pExt, (const TCHAR *)"tmp") == 0) return TRUE; // remember the current name String_256 pInFile = pTempPath->GetPath(); // change the extension pTempPath->SetType(pExt); // check if the file exists if (SGLibOil::FileExists(pTempPath)) { // make a recursive call BOOL ok = GetTemporaryPathName(pExt, pTempPath); // remove our .tmp file wxRemoveFile( (PCTSTR)pInFile ); return ok; } // try to rename the file wxString path = (PCTSTR)pTempPath->GetPath(); return wxRenameFile( (PCTSTR)pInFile, path ); }

PathName FileUtil::GetTemporaryPathName (   )  [static]

Simplified interface to GetTempFileName(). Author: Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com> Date: 2/5/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A path to a new temporary file Call this function when you want to create a new temporary file and want a pathname for it. The pathname that this function returns will be unique (i.e. will not point to an existing file), will begin with 'xar' and will be in the system's temporary directory. Returns: Errors: - See also: - Definition at line 423 of file fileutil.cpp. { //First get the directory in which to put our temporary files TCHAR pcPath[MAX_PATH] = _T(""); PORTNOTE("other", "This call is not needed, wxFileName::CreateTempFileName does the right thing" ) // FileUtil::GetTemporaryPath(MAX_PATH, pcPath); //Now get a temporary file name TCHAR pcFileName[MAX_PATH]; FileUtil::GetTemporaryFileName(pcPath, _T("xar"), 0, pcFileName); //And convert the file name into a PathName String_256 strFileName=pcFileName; PathName pthFileName(strFileName); //And return it return pthFileName; }

BOOL FileUtil::RecursiveCreateDirectory (  const String_256 &  strDirPath  )  [static]

Recursivly create directory path. Author: Luke_Hart (Xara Group Ltd) <lukeh@xara.com> Date: 18/07/2006 Parameters: strDirPath  - the path to verify and create [INPUTS] Returns: TRUE if succesful, FALSE otherwise Definition at line 604 of file fileutil.cpp. { // Go down path making sure each directory exists (and creating if needed), we // start from the second character becuase we don't want to deal with '/' UINT32 ord = 1; while( _T('\0') != strDirPath[ord] ) { if( _T('/') == strDirPath[ord] ) { String_256 strPath; strDirPath.Left( &strPath, ord ); if( !wxDir::Exists( (PCTSTR)strPath ) ) wxMkdir( (PCTSTR)strPath ); } ++ord; } // Make sure the path as a whole exists if( !wxDir::Exists( (PCTSTR)strDirPath ) ) wxMkdir( (PCTSTR)strDirPath ); return TRUE; }

BOOL FileUtil::SetCurrentDirectory (  const String_256 &  NewCurrentPath  )  [static]

Set up the operating system current directory. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 31/10/97 Parameters: NewCurrentPath  - the new current path to be used. [INPUTS] Returns: TRUE if succesful, FALSE otherwise Definition at line 701 of file fileutil.cpp. { // Call the OS to set the new current directory String_256 CurrentPath = NewCurrentPath; BOOL ok = ::SetCurrentDirectory( (TCHAR *)CurrentPath ); return ok; }

BOOL FileUtil::SetCurrentDirectory (  const PathName &  NewCurrentPath  )  [static]

Set up the operating system current directory. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 31/10/97 Parameters: NewCurrentPath  - the new current path to be used. [INPUTS] Returns: TRUE if succesful, FALSE otherwise Definition at line 680 of file fileutil.cpp. { String_256 CurrentPath = NewCurrentPath.GetPath(); // Call the OS to set the new current directory BOOL ok = ::SetCurrentDirectory( (TCHAR *)CurrentPath ); return ok; }

BOOL FileUtil::StartFindingFiles (  String_256 *  FileSpecifier  )  [static]

Scans a given directory for files matching a particular name. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/96 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 To find files, do something like the following PathName SearchPath("c:\\Directory\\*.*") if (FileUtil::StartFindingFiles(&SearchPath)) { String_256 LeafName; while (TRUE) { if (!FileUtilFindNextFile(&LeafName)) break; Do something with file "LeafName" String_256 FullPathName = "c:\\Directory\"; FullPathName += LeafName; TRACE( _T("Full file path name is %s\n"), (TCHAR *)FullPathName); } FileUtil::StopFindingFiles(); } Notes: This search is non-"re-entrant". Between calls to Start & Stop, any calls to start another search will give an Error3 and return failure. See also: FileUtil::FindNextFile; FileUtil::StopFindingFiles Definition at line 221 of file fileutil.cpp. { ERROR3IF(FileSpecifier == NULL, "Duff FileSpecifier param"); if (SearchActive) { ERROR3("StartFindingFiles called while already finding files! Call returns failure"); return(FALSE); } SearchActive = TRUE; s_fStarted = false; SearchPath = *FileSpecifier; return(TRUE); }

void FileUtil::StopFindingFiles (  void   )  [static]

Stops a directory scan. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/9/96 To find files, do something like the following See StartFindingFiles for example search code Notes: This code is non-re-entrant. Between calls to Start & Stop, any calls to start another search will give an Error3 and return failure. DO NOT CALL THIS FUNCTION if StartFindingFiles failed. Call this function exactly once for each call to StartFindingFiles. See also: FileUtil::StartFindingFiles; FileUtil::FindNextFile Definition at line 344 of file fileutil.cpp. { ERROR3IF(!SearchActive, "StopFindingFiles called when StartFindingFiles not called/failed"); s_fStarted = false; SearchActive = FALSE; }

---

Member Data Documentation

wxDir FileUtil::s_dirSearch [static, private]

Definition at line 164 of file fileutil.h.

bool FileUtil::s_fStarted = false [static, private]

Definition at line 162 of file fileutil.h.

BOOL FileUtil::SearchActive = FALSE [static, private]

Definition at line 161 of file fileutil.h.

String_256 FileUtil::SearchPath = TEXT("") [static, private]

Definition at line 163 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)

---