IFileOperation ::RenameItems, méthode (shobjidl_core.h)

Déclare un ensemble d’éléments qui doivent recevoir un nouveau nom d’affichage. Tous les éléments portent le même nom.

Syntaxe

HRESULT RenameItems(
  [in] IUnknown *pUnkItems,
  [in] LPCWSTR  pszNewName
);

Paramètres

[in] pUnkItems

Type : IUnknown*

Pointeur vers l’IUnknown de l’objet IShellItemArray, IDataObject ou IEnumShellItems qui représente le groupe d’éléments à renommer. Vous pouvez également pointer vers un objet IPersistIDList pour représenter un élément unique, accomplissant efficacement la même fonction que IFileOperation ::RenameItem.

[in] pszNewName

Type : LPCWSTR

Pointeur vers le nouveau nom d’affichage des éléments. Il s’agit d’une chaîne Unicode terminée par null.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si plusieurs éléments de la collection dans pUnkItems se trouvent dans le même dossier, les fichiers renommés sont ajoutés avec un nombre entre parenthèses pour les différencier, pour instance newfile(1).txt, newfile(2).txt et newfile(3).txt.

Cette méthode ne renomme pas les éléments, elle déclare simplement les éléments à renommer. Pour renommer un groupe d’objets, vous devez effectuer au moins la séquence d’appels détaillée ici :

1. Appelez IFileOperation ::RenameItems pour déclarer les fichiers ou dossiers sources et le nouveau nom.
2. Appelez IFileOperation ::P erformOperations pour commencer l’opération de renommage.

Configuration requise

Voir aussi

IFileOperation

IFileOperation ::RenameItem