Rename Method

In This Topic

Change the files name to the new unique name

Syntax

Visual Basic
C#

'Declaration
 
Public Function Rename( _
   ByVal originalFileNamePath As String, _
   ByVal newFileNamePath As String _
) As Boolean

public bool Rename( 
   string originalFileNamePath,
   string newFileNamePath
)

Parameters

originalFileNamePath: The fully qualified file name and path to rename
newFileNamePath: The new fully qualified file name and path

Return Value

True if a change was made to the collection, false otherwise.

Remarks

If no item is found with the original file name or new file name an exception will be thrown. If an item is found with the new file name and the original file name an exception will be thrown. If no item is found with the original file name but one is found with the new file name, the operation will be considered successful but return false (indicating no change).

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

FileReferenceCollection Class
FileReferenceCollection Members

Send Feedback