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

注釈

指定した名前が無効な場合、このメソッドは例外をスローします。 指定した名前が無効になる可能性があるすべての方法を処理するには、次の 4 つの例外をすべてキャッチする必要があります。

E_INVALIDARG
E_FAIL
ERROR_FILENAME_EXCED_RANGE
ERROR_INVALID_NAME

名前の変更が完了する前にファイルが削除された場合、このメソッドはERROR_FILE_NOT_FOUND例外をスローします。 このメソッドを使用する場合は、この例外をキャッチして処理する必要もあります。

こちらもご覧ください

適用対象

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

こちらもご覧ください

適用対象