StorageFolder.RenameAsync 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
多載
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
目前資料夾所需的新名稱。
傳回
這個方法在完成時不會傳回任何物件或值。
實作
M:Windows.Storage.IStorageItem.RenameAsync(System.String)
M:Windows.Storage.IStorageItem.RenameAsync(Platform::String)
M:Windows.Storage.IStorageItem.RenameAsync(winrt::hstring)
- 屬性
備註
如果您指定的名稱無效,此方法 (及其多載) 擲回例外狀況。 若要處理指定名稱可能不正確所有方式,您必須攔截這四個例外狀況:
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 會如何回應。
傳回
這個方法在完成時不會傳回任何物件或值。
實作
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)
- 屬性