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

Applies to Windows only

Renames the StorageFolder, and specifies what to do if a folder with the same name already exists.

Syntax


folderInformation.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 a folder with desiredName already exists.

Return value

Type: IAsyncAction

No object or value is returned when this method completes.

Requirements

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

FolderInformation
RenameAsync(String)