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

Déclare un seul élément qui doit recevoir un nouveau nom d’affichage.

Syntaxe

HRESULT RenameItem(
  [in] IShellItem                 *psiItem,
  [in] LPCWSTR                    pszNewName,
  [in] IFileOperationProgressSink *pfopsItem
);

Paramètres

[in] psiItem

Type : IShellItem*

Pointeur vers un objet IShellItem qui spécifie l’élément source.

[in] pszNewName

Type : LPCWSTR

Pointeur vers le nouveau nom complet de l’élément. Il s’agit d’une chaîne Unicode terminée par un caractère Null.

[in] pfopsItem

Type : IFileOperationProgressSink*

Pointeur vers un objet IFileOperationProgressSink à utiliser pour les notifications de status et d’échec. Si vous appelez IFileOperation::Advise pour l’opération globale, la progression status et les notifications d’erreur pour l’opération de renommage y sont incluses. Définissez donc ce paramètre sur 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

Cette méthode ne renomme pas l’élément, mais déclare simplement l’élément à renommer. Pour renommer un objet, vous devez effectuer au moins la séquence d’appels détaillée ici :

1. Appelez IFileOperation::RenameItem pour déclarer le nouveau nom.
2. Appelez IFileOperation::P erformOperations pour commencer l’opération de renommage.

Configuration requise

Voir aussi

IFileOperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem