Skip to main content
FileInformation.RenameAsync(String, NameCollisionOption) | renameAsync(String, NameCollisionOption) method

Renames the StorageFile, and specifies what to do if a file with the same name already exists in the current folder.

Syntax


fileInformation.renameAsync(desiredName, option).done( /* Your success and error handlers */ );

public IAsyncAction RenameAsync(
  string desiredName, 
  NameCollisionOption option
)

Public Function RenameAsync(
  desiredName As String,  
  option As NameCollisionOption 
) As IAsyncAction

public:
IAsyncAction^ RenameAsync(
  String^ desiredName, 
  NameCollisionOption option
)

Parameters

desiredName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The new name.

option

Type: NameCollisionOption

A value that indicates what to do if the file name already exists in the current folder.

Return value

Type: IAsyncAction

No object or value is returned when this method completes.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Storage.BulkAccess
Windows::Storage::BulkAccess [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

None supported

Namespace

Windows.Storage.BulkAccess
Windows::Storage::BulkAccess [C++]

Metadata

Windows.winmd

See also

FileInformation
RenameAsync(String)