Rename Method (IWritableFileInfoExtension)

Renames a file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Sub Rename( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal newFileName As String _
)

'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim newFileName As String
 
IWritableFileInfoExtension.Rename(writableFileInfo, newFileName)

[Extension()]
public static void Rename( 
   IWritableFileInfo writableFileInfo,
   string newFileName
)

[Extension()]
public:
static void Rename( 
   IWritableFileInfo^ writableFileInfo,
   String^ newFileName
)

Parameters

writableFileInfo: The writable file info object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
newFileName: New name of file.
The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.DirectoryNotFoundException	Part of a file or directory cannot be found. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.FileNotFoundException	An attempt to access a file that does not exist on disk has failed. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.IO.PathTooLongException	A path or fully qualified file name is longer than the system-defined maximum length. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method cannot be used to move a file; use the OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.MoveTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String) method to move and rename the file.

The original writable file info is (in general case) invalid after the rename. Obtain a new writable file info with the proper name to continue operations on the same file.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.CopyTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String)
OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.MoveTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String)

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.