Introduction.
We all know Dir() Function from the time of the Windows DOS Operating System. This is the first Command introduced to those who sit on a Personal Computer to learn how to use Computers. This command has several options, to get the output from the disk in so many ways, under Windows Operating System. You can take a full list of Folders, Subfolders, and Files from the hard disk in a single command. The entire list can be sent to a Printer or saved into a text file with the use of the redirection symbol (>).
We are not going to use all those options here. We will see how Dir() Function is used in VBA to read file names from a folder one by one and display them in the Debug Window. Every time we run this function with a Folder Path as a parameter, it returns the first file name from the folder. Now, the question is how to get the next few file names or all the files one-by-one from the Folder.
Using DIR Command in Debug Window.
We will try Dir() Function from the Debug Window directly so that it is easy to understand how to use this function to get a few file names from a folder one after the other.
- Open Microsoft Access VBA Window and then display Debug Window (Ctrl+G).
- Type the following command in the Debug Window and press Enter Key:
? Dir("")
Dir() Function with an empty string as a parameter will fetch the first file name from the Current Folder and display it in the debug window.
Since we have not given any specific folder name in the function parameter, it looks for files in the active folder on the disk.
- Now, issue the following command without any parameter to get the next file name in the current folder
? Dir() OR ? Dir
- Each time you run the DIR() command it will get the next file from the folder.
- Use a specific Folder Path as the parameter, in place of the empty string to get files from that particular folder.
- Example:
? Dir("D:\Documents\") OR ? Dir("D:\Documents\*.*")
If D:\Documents\ folder doesn't have any files in it then the above command will return an empty string. If you go further and execute the Dir command again, then it will end up with an error message.
There is an optional second parameter to the Dir() Command that we have not used in the above examples. Since this is a DOS Command executed in its own window we can specify this second parameter to show its normal window(vbNormal) or hide the execution window (vbHidden) among other options available.
A VBA Wrapper Function for DIR Function.
I have written a small function for you to list all the files in a folder in the Debug Window.
Public Function TestDir(ByVal strFolder As String) As String 'Function Usage e.g.: TestDir "D:\Documents\" Dim j As Integer, strFile As String 'files counter j = 1 'Run the function with the specified folder in a hidden window strFile = Dir(strFolder, vbHidden) 'Next steps of Dir() function is nested in a loop 'to read all the files and print in the Debug Window Do While Len(strFile) > 0 Debug.Print j & ":" & strFile j = j + 1 strFile = Dir() Loop End Function
Call the function from the Debug Window by giving the full path of the Folder as the parameter.
? TestDir("D:\Documents\") OR ? TestDir("D:\Documents\*.*")
All the files from the specified folder will be printed with a serial number in the debug window. After reading and printing the last file from the folder the Dir() function executes one more time and ends up with an empty string. The Do While condition will prove false and the program stops.
If you need only a specific type of File only to be read and display, then you may specify the parameter with the file type extension.
Example:
? TestDir("D:\Documents\*.xls")
The above example will read-only Excel files and print in the Debug window.
I have used the term Function and Command interchangeably. Dir() is referred to as a Function in VBA reference documents and as Command in Disk Operating System documents, both refer to the same operations done in different environments.
No comments:
Post a Comment
Comments subject to moderation before publishing.