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

備註

如果您指定的名稱無效，這個方法會擲回例外狀況。 若要處理指定名稱可能不正確所有方式，您必須攔截這四個例外狀況：

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)