IStorageItem.RenameAsync Method

Definition

Namespace:

Windows.Storage

Overloads

RenameAsync(String)	Renames the current item.
RenameAsync(String, NameCollisionOption)	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.

RenameAsync(String)

Renames the current item.

public:
 IAsyncAction ^ RenameAsync(Platform::String ^ desiredName);

/// [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 item.

Returns

IAsyncAction

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

Attributes

OverloadAttribute RemoteAsyncAttribute

Remarks

For this method and its overload, 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.

See also

• RenameAsync(String, NameCollisionOption)

RenameAsync(String, NameCollisionOption)

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.

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

/// [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 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

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.

Returns

IAsyncAction

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

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• RenameAsync(String)