StorageFolder.RenameAsync 方法

定义

命名空间:

Windows.Storage

重载

RenameAsync(String)	重命名当前文件夹。
RenameAsync(String, NameCollisionOption)	重命名当前文件夹，并指定在已存在同名文件夹时要执行的操作。

RenameAsync(String)

重命名当前文件夹。

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

参数

desiredName

String

Platform::String

winrt::hstring

当前文件夹的所需新名称。

返回

IAsyncAction

此方法在完成时不会返回任何对象或值。

实现

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

属性

OverloadAttribute RemoteAsyncAttribute

注解

如果指定的名称无效，则此方法 (，并且其重载) 将引发异常。 若要处理指定名称可能无效的所有方式，必须捕获以下所有四个异常：

E_INVALIDARG

E_FAIL

ERROR_FILENAME_EXCED_RANGE

ERROR_INVALID_NAME

如果在重命名完成之前删除文件，此方法将引发ERROR_FILE_NOT_FOUND异常。 使用此方法时，还必须捕获并处理此异常。

另请参阅

• RenameAsync(String, NameCollisionOption)

RenameAsync(String, NameCollisionOption)

重命名当前文件夹，并指定在已存在同名文件夹时要执行的操作。

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

参数

desiredName

String

Platform::String

winrt::hstring

当前文件夹的所需新名称。

如果当前文件夹位置中的现有项已具有指定的 desiredName，则指定的 NameCollisionOption 将确定 Windows 如何响应冲突。

option

NameCollisionOption

如果 desiredName 与当前文件夹位置中的现有项的名称相同，则确定 Windows 如何响应的枚举值。

返回

IAsyncAction

此方法在完成时不会返回任何对象或值。

实现

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)

属性

OverloadAttribute RemoteAsyncAttribute

另请参阅

• RenameAsync(String)