Rename Method (IWritableDirectoryContentsExtension)

Renames a directory.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function Rename( _
   ByVal writableDirectoryContents As IWritableDirectoryContents, _
   ByVal newDirectoryName As String _
) As IWritableDirectoryContents

'Usage
 
Dim writableDirectoryContents As IWritableDirectoryContents
Dim newDirectoryName As String
Dim value As IWritableDirectoryContents
 
value = IWritableDirectoryContentsExtension.Rename(writableDirectoryContents, newDirectoryName)

[Extension()]
[NotNull()]
public static IWritableDirectoryContents Rename( 
   IWritableDirectoryContents writableDirectoryContents,
   string newDirectoryName
)

[Extension()]
[NotNull()]
public:
static IWritableDirectoryContents^ Rename( 
   IWritableDirectoryContents^ writableDirectoryContents,
   String^ newDirectoryName
)

Parameters

writableDirectoryContents: The writable directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
newDirectoryName: New name for directory.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the writable directory contents for the renamed file.

This method never returns 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.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.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.

Remarks

This method cannot be used to move a directory; use the IWritableDirectoryContents.MoveTo method to move and rename the directory.

The original writable directory contents is (in general case) invalid after the rename. Use the writable directory contents returned by the method to continue operations on the same directory.

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

IWritableDirectoryContentsExtension Class
IWritableDirectoryContentsExtension Members

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.