Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IStorageItem.RenameAsync(String, NameCollisionOption) method

Applies to Windows and Windows Phone

Renames the current item. This method also specifies what to do if an existing item in the current item's location has the same name.

Syntax


IAsyncAction RenameAsync(
  string desiredName, 
  NameCollisionOption option
)

Parameters

desiredName

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

The desired, new name of the current item.

If there is an existing item in the current item's location that already has the specified desiredName, the specified NameCollisionOption determines how Windows responds to the conflict.

option

Type: NameCollisionOption

The enum value that determines how Windows responds if the desiredName is the same as the name of an existing item in the current item's location.

Return value

Type: IAsyncAction

No object or value is returned by this method when it completes.

Remarks

If the name you specify is invalid, this method throws an exception. To handle all the ways the specified name could be invalid, you must catch all four of these exceptions:

E_INVALIDARG
E_FAIL
ERROR_FILENAME_EXCED_RANGE
ERROR_INVALID_NAME

 

If the file is deleted before the rename finishes, this method throws the ERROR_FILE_NOT_FOUND exception. You must also catch and handle this exception when you use this method.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

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

Metadata

Windows.winmd

See also

IStorageItem
RenameAsync(String)

 

 

Show:
© 2014 Microsoft