IStorageItem.RenameAsync Méthode

Définition

Surcharges

RenameAsync(String)

Renomme l’élément actif.

RenameAsync(String, NameCollisionOption)

Renomme l’élément actif. Cette méthode spécifie également ce qu’il faut faire si un élément existant à l’emplacement de l’élément actuel porte le même nom.

RenameAsync(String)

Renomme l’élément actif.

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

Paramètres

desiredName
String

Platform::String

winrt::hstring

Nouveau nom souhaité de l’élément.

Retours

Aucun objet ou valeur n’est retourné par cette méthode lorsqu’elle se termine.

Attributs

Remarques

Pour cette méthode et sa surcharge, si le nom que vous spécifiez n’est pas valide, cette méthode lève une exception. Pour gérer toutes les façons dont le nom spécifié n’est pas valide, vous devez intercepter les quatre exceptions suivantes :

E_INVALIDARG
E_FAIL
ERROR_FILENAME_EXCED_RANGE
ERROR_INVALID_NAME

Si le fichier est supprimé avant la fin du changement de nom, cette méthode lève l’exception ERROR_FILE_NOT_FOUND. Vous devez également intercepter et gérer cette exception lorsque vous utilisez cette méthode.

Voir aussi

S’applique à

RenameAsync(String, NameCollisionOption)

Renomme l’élément actif. Cette méthode spécifie également ce qu’il faut faire si un élément existant à l’emplacement de l’élément actuel porte le même nom.

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

Paramètres

desiredName
String

Platform::String

winrt::hstring

Nouveau nom souhaité de l’élément actif.

S’il existe un élément à l’emplacement de l’élément actuel qui a déjà le desiredName spécifié, l’option NameCollisionOption spécifiée détermine la façon dont Windows répond au conflit.

option
NameCollisionOption

Valeur d’énumération qui détermine la façon dont Windows répond si desiredName est identique au nom d’un élément existant à l’emplacement de l’élément actuel.

Retours

Aucun objet ou valeur n’est retourné par cette méthode lorsqu’elle se termine.

Attributs

Voir aussi

S’applique à