CFileFind Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at CFileFind Class.

Performs local file searches and is the base class for CGopherFileFind and CFtpFileFind, which perform Internet file searches.

Syntax

class CFileFind : public CObject  

Members

Public Constructors

Name	Description
CFileFind::CFileFind	Constructs a CFileFind object.

Public Methods

Name	Description
CFileFind::Close	Closes the search request.
CFileFind::FindFile	Searches a directory for a specified file name.
CFileFind::FindNextFile	Continues a file search from a previous call to FindFile.
CFileFind::GetCreationTime	Gets the time the file was created.
CFileFind::GetFileName	Gets the name, including the extension, of the found file
CFileFind::GetFilePath	Gets the whole path of the found file.
CFileFind::GetFileTitle	Gets the title of the found file. The title does not include the extension.
CFileFind::GetFileURL	Gets the URL, including the file path, of the found file.
CFileFind::GetLastAccessTime	Gets the time that the file was last accessed.
CFileFind::GetLastWriteTime	Gets the time the file was last changed and saved.
CFileFind::GetLength	Gets the length of the found file, in bytes.
CFileFind::GetRoot	Gets the root directory of the found file.
CFileFind::IsArchived	Determines if the found file is archived.
CFileFind::IsCompressed	Determines if the found file is compressed.
CFileFind::IsDirectory	Determines if the found file is a directory.
CFileFind::IsDots	Determines if the name of the found file has the name "." or "..", indicating that is actually a directory.
CFileFind::IsHidden	Determines if the found file is hidden.
CFileFind::IsNormal	Determines if the found file is normal (in other words, has no other attributes).
CFileFind::IsReadOnly	Determines if the found file is read-only.
CFileFind::IsSystem	Determines if the found file is a system file.
CFileFind::IsTemporary	Determines if the found file is temporary.
CFileFind::MatchesMask	Indicates the desired file attributes of the file to be found.

Protected Methods

Name	Description
CFileFind::CloseContext	Closes the file specified by the current search handle.

Protected Data Members

Name	Description
CFileFind::m_pTM	Pointer to a CAtlTransactionManager object.

Remarks

CFileFind includes member functions that begin a search, locate a file, and return the title, name, or path of the file. For Internet searches, the member function GetFileURL returns the file's URL.

CFileFind is the base class for two other MFC classes designed to search particular server types: CGopherFileFind works specifically with gopher servers, and CFtpFileFind works specifically with FTP servers. Together, these three classes provide a seamless mechanism for the client to find files, regardless of the server protocol, the file type, or location, on either a local machine or a remote server.

The following code will enumerate all the files in the current directory, printing the name of each file:

            CFileFind finder;
            BOOL bWorking = finder.FindFile(_T("*.*"));
            while (bWorking)
            {
               bWorking = finder.FindNextFile();
               TRACE(_T("%s\n"), (LPCTSTR)finder.GetFileName());
            } 

To keep the example simple, this code uses the standard C++ library cout class. The cout line could be replaced with a call to CListBox::AddString, for example, in a program with a graphical user interface.

For more information about how to use CFileFind and the other WinInet classes, see the article Internet Programming with WinInet.

Inheritance Hierarchy

CObject

CFileFind

Requirements

Header: afx.h

CFileFind::CFileFind

This member function is called when a CFileFind object is constructed.

CFileFind();  
CFileFind(CAtlTransactionManager* pTM);

Parameters

pTM
Pointer to CAtlTransactionManager object

Example

See the example for CFileFind::GetFileName.

CFileFind::Close

Call this member function to end the search, reset the context, and release all resources.

void Close();

Remarks

After calling Close, you do not have to create a new CFileFind instance before calling FindFile to begin a new search.

Example

See the example for CFileFind::GetFileName.

CFileFind::CloseContext

Closes the file specified by the current search handle.

virtual void CloseContext();

Remarks

Closes the file specified by the current value of the search handle. Override this function to change the default behavior.

You must call the FindFile or FindNextFile functions at least once to retrieve a valid search handle. The FindFile and FindNextFile functions use the search handle to locate files with names that match a given name.

CFileFind::FindFile

Call this member function to open a file search.

virtual BOOL FindFile(
    LPCTSTR pstrName = NULL,  
    DWORD dwUnused = 0);

Parameters

pstrName
A pointer to a string containing the name of the file to find. If you pass NULL for pstrName, FindFile does a wildcard (*.*) search.

dwUnused
Reserved to make FindFile polymorphic with derived classes. Must be 0.

Return Value

Nonzero if successful; otherwise 0. To get extended error information, call the Win32 function GetLastError.

Remarks

After calling FindFile to begin the file search, call FindNextFile to retrieve subsequent files. You must call FindNextFile at least once before calling any of the following attribute member functions:

• GetCreationTime

• GetFileName

• GetFileTitle

• GetFilePath

• GetFileURL

• GetLastAccessTime

• GetLastWriteTime

• GetLength

• GetRoot

• IsArchived

• IsCompressed

• IsDirectory

• IsDots

• IsHidden

• IsNormal

• IsReadOnly

• IsSystem

• IsTemporary

• MatchesMask

Example

See the example for CFileFind::IsDirectory.

CFileFind::FindNextFile

Call this member function to continue a file search from a previous call to FindFile.

virtual BOOL FindNextFile();

Return Value

Nonzero if there are more files; zero if the file found is the last one in the directory or if an error occurred. To get extended error information, call the Win32 function GetLastError. If the file found is the last file in the directory, or if no matching files can be found, the GetLastError function returns ERROR_NO_MORE_FILES.

Remarks

You must call FindNextFile at least once before calling any of the following attribute member functions:

• GetCreationTime

• GetFileName

• GetFileTitle

• GetFilePath

• GetFileURL

• GetLastAccessTime

• GetLastWriteTime

• GetLength

• GetRoot

• IsArchived

• IsCompressed

• IsDirectory

• IsDots

• IsHidden

• IsNormal

• IsReadOnly

• IsSystem

• IsTemporary

• MatchesMask

FindNextFile wraps the Win32 function FindNextFile.

Example

See the example for CFileFind::IsDirectory.

CFileFind::GetCreationTime

Call this member function to get the time the specified file was created.

virtual BOOL GetCreationTime(FILETIME* pTimeStamp) const;  
virtual BOOL GetCreationTime(CTime& refTime) const;  

Parameters

pTimeStamp
A pointer to a FILETIME structure containing the time the file was created.

refTime
A reference to a CTime object.

Return Value

Nonzero if successful; 0 if unsuccessful. GetCreationTime returns 0 only if FindNextFile has never been called on this CFileFind object.

Remarks

You must call FindNextFile at least once before calling GetCreationTime.

Example

See the example for CFileFind::GetLength.

CFileFind::GetFileName

Call this member function to get the name of the found file.

virtual CString GetFileName() const;  

Return Value

The name of the most-recently-found file.

Remarks

You must call FindNextFile at least once before calling GetFileName.

GetFileName is one of three CFileFind member functions that return some form of the file name. The following list describes the three and how they vary:

• GetFileName returns the file name, including the extension. For example, calling GetFileName to generate a user message about the file c:\myhtml\myfile.txt returns the file name myfile.txt.

• GetFilePath returns the entire path for the file. For example, calling GetFilePath to generate a user message about the file c:\myhtml\myfile.txt returns the file path c:\myhtml\myfile.txt.

• GetFileTitle returns the file name, excluding the file extension. For example, calling GetFileTitle to generate a user message about the file c:\myhtml\myfile.txt returns the file title myfile.

Example

            CFileFind finder;
            static const TCHAR szFileToFind[] = _T("C:\\WINDOWS\\SYSTEM.INI");

            BOOL bResult = finder.FindFile(szFileToFind);

            if (bResult)
            {
               finder.FindNextFile();

               TRACE(_T("Root of %s is %s\n"), szFileToFind, 
                  (LPCTSTR)finder.GetRoot());

               TRACE(_T("Title of %s is %s\n"), szFileToFind, 
                  (LPCTSTR)finder.GetFileTitle());

               TRACE(_T("Path of %s is %s\n"), szFileToFind,
                  (LPCTSTR)finder.GetFilePath());

               TRACE(_T("URL of %s is %s\n"), szFileToFind,
                  (LPCTSTR)finder.GetFileURL());

               TRACE(_T("Name of %s is %s\n"), szFileToFind,
                  (LPCTSTR)finder.GetFileName());

               finder.Close();
            }
            else
            {
               TRACE(_T("You have no %s file.\n"), szFileToFind);
            }

CFileFind::GetFilePath

Call this member function to get the full path of the specified file.

virtual CString GetFilePath() const;  

Return Value

The path of the specified file.

Remarks

You must call FindNextFile at least once before calling GetFilePath.

GetFilePath is one of three CFileFind member functions that return some form of the file name. The following list describes the three and how they vary:

• GetFileName returns the file name, including the extension. For example, calling GetFileName to generate a user message about the file c:\myhtml\myfile.txt returns the file name myfile.txt.

• GetFilePath returns the entire path for the file. For example, calling GetFilePath to generate a user message about the file c:\myhtml\myfile.txt returns the file path c:\myhtml\myfile.txt.

• GetFileTitle returns the file name, excluding the file extension. For example, calling GetFileTitle to generate a user message about the file c:\myhtml\myfile.txt returns the file title myfile.

Example

See the example for CFileFind::GetFileName.

CFileFind::GetFileTitle

Call this member function to get the title of the found file.

virtual CString GetFileTitle() const;  

Return Value

The title of the file.

Remarks

You must call FindNextFile at least once before calling GetFileTitle.

GetFileTitle is one of three CFileFind member functions that return some form of the file name. The following list describes the three and how they vary:

• GetFileName returns the file name, including the extension. For example, calling GetFileName to generate a user message about the file c:\myhtml\myfile.txt returns the file name myfile.txt.

• GetFilePath returns the entire path for the file. For example, calling GetFilePath to generate a user message about the file c:\myhtml\myfile.txt returns the file path c:\myhtml\myfile.txt.

• GetFileTitle returns the file name, excluding the file extension. For example, calling GetFileTitle to generate a user message about the file c:\myhtml\myfile.txt returns the file title myfile.

Example

See the example for CFileFind::GetFileName.

CFileFind::GetFileURL

Call this member function to retrieve the specified URL.

virtual CString GetFileURL() const;  

Return Value

The complete URL.

Remarks

You must call FindNextFile at least once before calling GetFileURL.

GetFileURL is similar to the member function GetFilePath, except that it returns the URL in the form file://path. For example, calling GetFileURL to get the complete URL for myfile.txt returns the URL file://c:\myhtml\myfile.txt.

Example

See the example for CFileFind::GetFileName.

CFileFind::GetLastAccessTime

Call this member function to get the time that the specified file was last accessed.

virtual BOOL GetLastAccessTime(CTime& refTime) const;  
virtual BOOL GetLastAccessTime(FILETIME* pTimeStamp) const;  

Parameters

refTime
A reference to a CTime object.

pTimeStamp
A pointer to a FILETIME structure containing the time the file was last accessed.

Return Value

Nonzero if successful; 0 if unsuccessful. GetLastAccessTime returns 0 only if FindNextFile has never been called on this CFileFind object.

Remarks

You must call FindNextFile at least once before calling GetLastAccessTime.

Example

See the example for CFileFind::GetLength.

CFileFind::GetLastWriteTime

Call this member function to get the last time the file was changed.

virtual BOOL GetLastWriteTime(FILETIME* pTimeStamp) const;  
virtual BOOL GetLastWriteTime(CTime& refTime) const;  

Parameters

pTimeStamp
A pointer to a FILETIME structure containing the time the file was last written to.

refTime
A reference to a CTime object.

Return Value

Nonzero if successful; 0 if unsuccessful. GetLastWriteTime returns 0 only if FindNextFile has never been called on this CFileFind object.

Remarks

You must call FindNextFile at least once before calling GetLastWriteTime.

Example

See the example for CFileFind::GetLength.

CFileFind::GetLength

Call this member function to get the length of the found file, in bytes.

ULONGLONG GetLength() const;  

Return Value

The length of the found file, in bytes.

Remarks

You must call FindNextFile at least once before calling GetLength.

GetLength uses the Win32 structure WIN32_FIND_DATA to get and return the value of the file size, in bytes.

Example

            // This code fragment prints out a very verbose directory
            // listing for all the files in the root directory on the
            // C: drive. After the file's name, each attribute of the
            // file is printed, as are the creation, last access, and 
            // last write times.

            CFileFind finder;

            BOOL bWorking = finder.FindFile(_T("C:\\*.*"));

            while (bWorking)
            {
               bWorking = finder.FindNextFile();

               _tprintf_s(_T("%s\n\t"), (LPCTSTR)finder.GetFileName());
               _tprintf_s(_T("%c"), finder.IsArchived()   ? 'A' : 'a');
               _tprintf_s(_T("%c"), finder.IsCompressed() ? 'C' : 'c');
               _tprintf_s(_T("%c"), finder.IsHidden()     ? 'H' : 'h');
               _tprintf_s(_T("%c"), finder.IsNormal()     ? 'N' : 'n');
               _tprintf_s(_T("%c"), finder.IsReadOnly()   ? 'R' : 'r');
               _tprintf_s(_T("%c"), finder.IsSystem()     ? 'S' : 's');
               _tprintf_s(_T("%c"), finder.IsTemporary()  ? 'T' : 't');

               _tprintf_s(_T("\t%I64u byte(s)\n"), finder.GetLength());
               
               CTime tempTime;
               CString str;
               
               _tprintf_s(_T("\tCreated    : "));
               if (finder.GetCreationTime(tempTime))
               {
                  str = tempTime.Format(_T("%c"));
                  _tprintf_s(_T("%s\n"), (LPCTSTR) str);
               }
               else
               {
                  _tprintf_s(_T("(unavailable)\n"));
               }

               _tprintf_s(_T("\tLast Access: "));
               if (finder.GetLastAccessTime(tempTime))
               {
                  str = tempTime.Format(_T("%c"));
                  _tprintf_s(_T("%s\n"), (LPCTSTR) str);
               }
               else
               {
                  _tprintf_s(_T("(unavailable)\n"));
               }

               _tprintf_s(_T("\tLast Write : "));
               if (finder.GetLastWriteTime(tempTime))
               {
                  str = tempTime.Format(_T("%c"));
                  _tprintf_s(_T("%s\n"), (LPCTSTR) str);
               }
               else
               {
                  _tprintf_s(_T("(unavailable)\n"));
               }

               _tprintf_s(_T("\n"));
            } 

CFileFind::GetRoot

Call this member function to get the root of the found file.

virtual CString GetRoot() const;  

Return Value

The root of the active search.

Remarks

You must call FindNextFile at least once before calling GetRoot.

This member function returns the drive specifier and path name used to start a search. For example, calling FindFile with *.dat results in GetRoot returning an empty string. Passing a path, such as c:\windows\system\*.dll, to FindFile results GetRoot returning c:\windows\system\.

Example

See the example for CFileFind::GetFileName.

CFileFind::IsArchived

Call this member function to determine if the found file is archived.

BOOL IsArchived() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

Applications mark an archive file, which is to be backed up or removed, with FILE_ATTRIBUTE_ARCHIVE, a file attribute identified in the WIN32_FIND_DATA structure.

You must call FindNextFile at least once before calling IsArchived.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsCompressed

Call this member function to determine if the found file is compressed.

BOOL IsCompressed() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

A compressed file is marked with FILE_ATTRIBUTE_COMPRESSED, a file attribute identified in the WIN32_FIND_DATA structure. For a file, this attribute indicates that all of the data in the file is compressed. For a directory, this attribute indicates that compression is the default for newly created files and subdirectories.

You must call FindNextFile at least once before calling IsCompressed.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsDirectory

Call this member function to determine if the found file is a directory.

BOOL IsDirectory() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

A file that is a directory is marked with FILE_ATTRIBUTE_DIRECTORY a file attribute identified in the WIN32_FIND_DATA structure.

You must call FindNextFile at least once before calling IsDirectory.

See the member function MatchesMask for a complete list of file attributes.

Example

This small program recurses every directory on the C:\ drive and prints the name of the directory.

void Recurse(LPCTSTR pstr)
{
   CFileFind finder;

   // build a string with wildcards
   CString strWildcard(pstr);
   strWildcard += _T("\\*.*");

   // start working for files
   BOOL bWorking = finder.FindFile(strWildcard);

   while (bWorking)
   {
      bWorking = finder.FindNextFile();

      // skip . and .. files; otherwise, we'd
      // recur infinitely!

      if (finder.IsDots())
         continue;

      // if it's a directory, recursively search it

      if (finder.IsDirectory())
      {
         CString str = finder.GetFilePath();
         TRACE(_T("%s\n"), (LPCTSTR)str);
         Recurse(str);
      }
   }

   finder.Close();
}

void PrintDirs()
{
   Recurse(_T("C:"));
}

CFileFind::IsDots

Call this member function to test for the current directory and parent directory markers while iterating through files.

virtual BOOL IsDots() const;  

Return Value

Nonzero if the found file has the name "." or "..", which indicates that the found file is actually a directory. Otherwise 0.

Remarks

You must call FindNextFile at least once before calling IsDots.

Example

See the example for CFileFind::IsDirectory.

CFileFind::IsHidden

Call this member function to determine if the found file is hidden.

BOOL IsHidden() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

Hidden files, which are marked with FILE_ATTRIBUTE_HIDDEN, a file attribute identified in the WIN32_FIND_DATA structure. A hidden file is not included in an ordinary directory listing.

You must call FindNextFile at least once before calling IsHidden.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsNormal

Call this member function to determine if the found file is a normal file.

BOOL IsNormal() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

Files marked with FILE_ATTRIBUTE_NORMAL, a file attribute identified in the WIN32_FIND_DATA structure. A normal file has no other attributes set. All other file attributes override this attribute.

You must call FindNextFile at least once before calling IsNormal.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsReadOnly

Call this member function to determine if the found file is read-only.

BOOL IsReadOnly() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

A read-only file is marked with FILE_ATTRIBUTE_READONLY, a file attribute identified in the WIN32_FIND_DATA structure. Applications can read such a file, but they cannot write to it or delete it.

You must call FindNextFile at least once before calling IsReadOnly.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsSystem

Call this member function to determine if the found file is a system file.

BOOL IsSystem() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

A system file is marked with FILE_ATTRIBUTE_SYSTEM, , a file attribute identified in the WIN32_FIND_DATA structure. A system file is part of, or is used exclusively by, the operating system.

You must call FindNextFile at least once before calling IsSystem.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::IsTemporary

Call this member function to determine if the found file is a temporary file.

BOOL IsTemporary() const;  

Return Value

Nonzero if successful; otherwise 0.

Remarks

A temporary file is marked with FILE_ATTRIBUTE_TEMPORARY, a file attribute identified in the WIN32_FIND_DATA structure. A temporary file is used for temporary storage. Applications should write to the file only if absolutely necessary. Most of the file's data remains in memory without being flushed to the media because the file will soon be deleted.

You must call FindNextFile at least once before calling IsTemporary.

See the member function MatchesMask for a complete list of file attributes.

Example

See the example for CFileFind::GetLength.

CFileFind::m_pTM

Pointer to a CAtlTransactionManager object.

CAtlTransactionManager* m_pTM;  

Remarks

CFileFind::MatchesMask

Call this member function to test the file attributes on the found file.

virtual BOOL MatchesMask(DWORD dwMask) const;  

Parameters

dwMask
Specifies one or more file attributes, identified in the WIN32_FIND_DATA structure, for the found file. To search for multiple attributes, use the bitwise OR (|) operator. Any combination of the following attributes is acceptable:

• FILE_ATTRIBUTE_ARCHIVE The file is an archive file. Applications use this attribute to mark files for backup or removal.

• FILE_ATTRIBUTE_COMPRESSED The file or directory is compressed. For a file, this means that all of the data in the file is compressed. For a directory, this means that compression is the default for newly created files and subdirectories.

• FILE_ATTRIBUTE_DIRECTORY The file is a directory.

• FILE_ATTRIBUTE_NORMAL The file has no other attributes set. This attribute is valid only if used alone. All other file attributes override this attribute.

• FILE_ATTRIBUTE_HIDDEN The file is hidden. It is not to be included in an ordinary directory listing.

• FILE_ATTRIBUTE_READONLY The file is read only. Applications can read the file but cannot write to it or delete it.

• FILE_ATTRIBUTE_SYSTEM The file is part of or is used exclusively by the operating system.

• FILE_ATTRIBUTE_TEMPORARY The file is being used for temporary storage. Applications should write to the file only if absolutely necessary. Most of the file's data remains in memory without being flushed to the media because the file will soon be deleted.

Return Value

Nonzero if successful; otherwise 0. To get extended error information, call the Win32 function GetLastError.

Remarks

You must call FindNextFile at least once before calling MatchesMask.

Example

            // This code fragment shows all of the files in the root directory
            // of drive C: which have either the hidden attribute or the system
            // attribute, or both.

            CFileFind finder;

            BOOL bWorking = finder.FindFile(_T("C:\\*.*"));

            while (bWorking)
            {
               bWorking = finder.FindNextFile();

               if (finder.MatchesMask(FILE_ATTRIBUTE_HIDDEN | 
                  FILE_ATTRIBUTE_SYSTEM))
               {
                  _tprintf_s(_T("%s\n"), (LPCTSTR) finder.GetFileName());
               }
            }

See Also

CObject Class
Hierarchy Chart
CFtpFileFind Class
CGopherFileFind Class
CInternetFile Class
CGopherFile Class
CHttpFile Class