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

Значение перечисления, определяющее, как Windows отвечает, если desiredName совпадает с именем существующего элемента в расположении текущей папки.

Возвращаемое значение

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)