IStorageItem.RenameAsync Метод

Определение

Пространство имен:

Windows.Storage

Перегрузки

RenameAsync(String)	Переименовывает текущий элемент.
RenameAsync(String, NameCollisionOption)	Переименовывает текущий элемент. Этот метод также указывает, что делать, если существующий элемент в расположении текущего элемента имеет то же имя.

RenameAsync(String)

Переименовывает текущий элемент.

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

Параметры

desiredName

String

Platform::String

winrt::hstring

Нужное новое имя элемента.

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

IAsyncAction

После завершения этот метод не возвращает объект или значение.

Атрибуты

OverloadAttribute RemoteAsyncAttribute

Комментарии

Если для этого метода и его перегрузки указано недопустимое имя, этот метод создает исключение. Чтобы обработать все способы, которыми указанное имя может быть недопустимым, необходимо перехватить все четыре из этих исключений:

E_INVALIDARG

E_FAIL

ERROR_FILENAME_EXCED_RANGE

ERROR_INVALID_NAME

Если файл удаляется до завершения переименования, этот метод вызывает исключение ERROR_FILE_NOT_FOUND. При использовании этого метода также необходимо перехватывать и обрабатывать это исключение.

См. также раздел

• RenameAsync(String, NameCollisionOption)

RenameAsync(String, NameCollisionOption)

Переименовывает текущий элемент. Этот метод также указывает, что делать, если существующий элемент в расположении текущего элемента имеет то же имя.

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

Параметры

desiredName

String

Platform::String

winrt::hstring

Нужное новое имя текущего элемента.

Если в текущем расположении есть элемент, который уже имеет указанное значение desiredName, указанное свойство NameCollisionOption определяет, как Windows реагирует на конфликт.

option

NameCollisionOption

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

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

IAsyncAction

После завершения этот метод не возвращает объект или значение.

Атрибуты

OverloadAttribute RemoteAsyncAttribute

См. также раздел

• RenameAsync(String)