Share via

StorageFile.RenameAsync Method

Definition

Namespace:
Windows.Storage

Overloads

RenameAsync(String)

Renames the current file.
RenameAsync(String, NameCollisionOption)

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

RenameAsync(String)

Edit

Renames the current file.

public:
 virtual IAsyncAction ^ RenameAsync(Platform::String ^ desiredName) = RenameAsync;
/// [Windows.Foundation.Metadata.Overload("RenameAsyncOverloadDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction RenameAsync(winrt::hstring const& desiredName);
[Windows.Foundation.Metadata.Overload("RenameAsyncOverloadDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction RenameAsync(string desiredName);
function renameAsync(desiredName)
Public Function RenameAsync (desiredName As String) As IAsyncAction

Parameters

desiredName
String

Platform::String

winrt::hstring

The desired, new name of the current item.

Returns

IAsyncAction

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

Implements

M:Windows.Storage.IStorageItem.RenameAsync(System.String) M:Windows.Storage.IStorageItem.RenameAsync(Platform::String) M:Windows.Storage.IStorageItem.RenameAsync(winrt::hstring)
Attributes
OverloadAttribute RemoteAsyncAttribute

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 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.

If there's an existing item in the current file's ___location that already has the specified desiredName, the RenameAsync(String, NameCollisionOption) method should be used instead to specify how Windows responds to the conflict. This method doesn't allow you to specify a NameCollisionOption value, and the default behavior is to always throw an exception if there's a name conflict.

See also

Applies to

RenameAsync(String, NameCollisionOption)

Edit

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

public:
 virtual IAsyncAction ^ RenameAsync(Platform::String ^ desiredName, NameCollisionOption option) = RenameAsync;
/// [Windows.Foundation.Metadata.Overload("RenameAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction RenameAsync(winrt::hstring const& desiredName, NameCollisionOption const& option);
[Windows.Foundation.Metadata.Overload("RenameAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction RenameAsync(string desiredName, NameCollisionOption option);
function renameAsync(desiredName, option)
Public Function RenameAsync (desiredName As String, option As NameCollisionOption) As IAsyncAction

Parameters

desiredName
String

Platform::String

winrt::hstring

The desired, new name of the current file.

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

option
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 file's ___location.

Returns

IAsyncAction

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

Implements

M:Windows.Storage.IStorageItem.RenameAsync(System.String,Windows.Storage.NameCollisionOption) M:Windows.Storage.IStorageItem.RenameAsync(Platform::String,Windows.Storage.NameCollisionOption) M:Windows.Storage.IStorageItem.RenameAsync(winrt::hstring,Windows.Storage.NameCollisionOption)
Attributes
OverloadAttribute RemoteAsyncAttribute

See also

Applies to