Namefunction

Renames a file on disk

Syntax

Declare Function Name( ByRef oldname As Const String, ByRef newname As Const String ) As Long

Parameters

Return value

Returns zero (0) on success and non-zero on failure.

Description

Renames a file or folder originally called oldname to newname.

The function is not guaranteed to succeed if a file/folder exists with the same name. It may succeed, overwriting the original, or it may fail. For greater control, FileExists could be used to test for an existing file, and Kill could be used to delete an existing file beforehand.

Remarks

Usage


result = Name( oldname, newname )


Differences from QB

• In QB, NAME required AS rather than a comma between the old and new names. This is because NAME was a language keyword rather than a function.
  
  

See also

• Kill
  
• FileExists
  
  

Example

Dim OldName As String

Dim NewName As String

Dim result As Long 



OldName = "dsc001.jpg"

NewName = "landscape.jpg"



result = Name( OldName, NewName )

If 0 <> result Then 

    Print "error renaming " & oldname & " to " & newname & "."

End If

Reference

• Documented in KeyPgName.html