How to Rename a File or Folder (Directory) from VBA, Visual Basic 6, Microsoft Office/Access/Excel

Provided by the FMS Development Team

Did you know there is a built-in statement in VB6/VBA/Office/Access/Excel that allows you to do this without using API calls and without referencing the File System?

The Name statement moves the file to the new directory or folder and renames the file, if necessary. Here's the syntax:

Name OldPathName As NewPathName

Name can move a file across drives, but it can only rename an existing directory or folder when both OldPathName and NewPathName are located on the same drive. Name cannot create a new file, directory, or folder.

If OldPathName and NewPathName have different paths, and the same file name, the Name statement moves the file to the new location and leaves the file name unchanged.

Using Name, you can move a file from one directory or folder to another, but you cannot move a directory or folder.

Using Name on an open file produces an error. You must close an open file before renaming it. Name arguments cannot include multiple-character (*) and single-character (?) wildcards.

Our example below only provides support for files or simple folder renaming (e.g. the path folder does not exist). Renaming a directory to a name that already exists is more complicated and may be included in a future tip.

Public Function TestNameStatement()
  Dim fOK As Boolean
  ' Folders must exist for Source, but do not need to exist for destination
  fOK = RenameFileOrDir("C:\TestFolder\test.txt", "C:\TestFolder\test_NEWNAME.txt")
  fOK = RenameFileOrDir("C:\TestFolder\test.txt", "D:\TestFolder\test_NEWNAME.txt")
  ' Folder must exist for source
  fOK = RenameFileOrDir("C:\TestFolder", "C:\TestFolder_NEWNAME")
  ' Folders only will fail across drives
  fOK = RenameFileOrDir("C:\TestFolder", "D:\TestFolder")  
End Function

Public Function RenameFileOrDir(ByVal strSource As String, ByVal strTarget As String, _
  Optional fOverwriteTarget As Boolean = False) As Boolean
  On Error GoTo PROC_ERR
  Dim fRenameOK As Boolean
  Dim fRemoveTarget As Boolean
  Dim strFirstDrive As String
  Dim strSecondDrive As String
  Dim fOK As Boolean
  If Not ((Len(strSource) = 0) Or (Len(strTarget) = 0) Or (Not (FileOrDirExists(strSource)))) Then
    ' Check if the target exists
    If FileOrDirExists(strTarget) Then
      If fOverwriteTarget Then
        fRemoveTarget = True
        If MsgBox("Do you wish to overwrite the target file?", vbExclamation + vbYesNo, "Overwrite confirmation") = vbYes Then
          fRemoveTarget = True
        End If
      End If
      If fRemoveTarget Then
        ' Check that it's not a directory
        If ((GetAttr(strTarget) And vbDirectory)) <> vbDirectory Then
          Kill strTarget
          fRenameOK = True
          MsgBox "Cannot overwrite a directory", vbOKOnly, "Cannot perform operation"
        End If
      End If      
      ' The target does not exist
      ' Check if source is a directory
      If ((GetAttr(strSource) And vbDirectory) = vbDirectory) Then          
        ' Source is a directory, see if drives are the same
        strFirstDrive = Left(strSource, InStr(strSource, ":\"))
        strSecondDrive = Left(strTarget, InStr(strTarget, ":\"))
        If strFirstDrive = strSecondDrive Then
          fRenameOK = True
          MsgBox "Cannot rename directories across drives", vbOKOnly, "Cannot perform operation"
        End If      
        ' It's a file, ok to proceed
        fRenameOK = True
      End If
    End If
    If fRenameOK Then
      Name strSource As strTarget
      fOK = True
    End If
  End If
  RenameFileOrDir = fOK
  Exit Function
  MsgBox "Error: " & Err.Number & ". " & Err.Description, , "RenameFileOrDir"
  Resume PROC_EXIT 
End Function
Public Function FileOrDirExists(strDest As String) As Boolean
  Dim intLen As Integer
  Dim fReturn As Boolean

  fReturn = False

  If strDest <> vbNullString Then
    On Error Resume Next
    intLen = Len(Dir$(strDest, vbDirectory + vbNormal))
    On Error GoTo PROC_ERR
    fReturn = (Not Err And intLen > 0)
  End If

  FileOrDirExists= fReturn
  Exit Function

  MsgBox "Error: " & Err.Number & ". " & Err.Description, , "FileOrDirExists"
  Resume PROC_EXIT
End Function

For other VBA and VB6 Source Code, check out our Total Visual SourceBook code library with royalty-free code you can add to your applications.

Table Design

Query Design

Form Design

Form Tips and Mistakes

Copy Command Button and Keep Picture

Module VBA to Forms and Controls

Form Navigation Caption

Resync Record in a Subform

Synchronize Two Subforms

Multiple OpenArgs Values

Late Bind Tab Subforms

Subform Reference to Control Rather than Field

Tab Page Reference

Shortcut Keys

Combo Box Top 6 Tips

Properties and Validation

Select First Item

Cascading Combo Boxes

Zip, City, State AutoFill

Report Design

Suppress Page Headers and Footers on the First Page of Your Report

Add the NoData Event

Annual Monthly Crosstab Columns

Design Environment

Add Buttons to the Quick Access Toolbar

Collapse the Office Ribbon for more space

VBA Programming

Basics: Forms and Controls

Run VBA Code from a Macro

Use Nz() to Handle Nulls

Avoid Exits in the Body of a Procedure

Shortcut Debugging Keys

Set Module Options

Math Rounding Issues

Rename a File or Folder

Avoid DoEvents in Loops

Age Calculations

Weekday Math

Send Emails with DoCmd.SendObject

Source Code Library

Microsoft Access Modules Library

Microsoft Access Modules

VBA Error Handling

Error Handling and Debugging Techniques

Error Number and Description Reference

Basic Error Handling

Pinpointing the Error Line

Performance Tips

Linked Database

Subdatasheet Name

Visual SourceSafe


Runtime Downloads

Simulate Runtime

Prevent Close Box

Disable Design Changes

Broken References

Remote Desktop Connection Setup

Terminal Services and RemoteApp Deployment

Reboot Remote Desktop

Missing Package & Deployment Wizard

Avoid Program Files Folder

Unavailable Mapped Drives

Microsoft Access Front-End Deployment

System Admin

Disaster Recovery Plan

Compact Database

Compact on Close

Database Corruption

Remove 'Save to SharePoint Site' Prompt from an Access Database

Class Not Registered Run-time Error -2147221164

Inconsistent Compile Error

Decompile Database

Bad DLL Calling Convention

Error 3045: Could Not Use

Converting ACCDB to MDB

SQL Server Upsizing

Microsoft Access to SQL Server Upsizing Center

Microsoft Access to SQL Server Upsizing Center

When and How to Upsize Access to SQL Server

SQL Server Express Versions and Downloads

Cloud and Azure

Cloud Implications

MS Access and SQL Azure

Deploying MS Access Linked to SQL Azure

SQL Server Azure Usage and DTU Limits

Visual Studio LightSwitch

LightSwitch Introduction

Comparison Matrix

Additional Resources

Connect with Us


Free Product Catalog from FMS