Méthode ITransferSource ::RenameItem (shobjidl_core.h)

Article
03/06/2024

Modifie le nom d’un élément, en retournant l’objet IShellItem avec le nouveau nom.

Syntaxe

HRESULT RenameItem(
  [in]  IShellItem            *psiSource,
  [in]  LPCWSTR               pszNewName,
  [in]  TRANSFER_SOURCE_FLAGS flags,
  [out] IShellItem            **ppsiNewDest
);

Paramètres

[in] psiSource

Type : IShellItem*

Pointeur vers l’objet IShellItem à renommer.

[in] pszNewName

Type : LPCWSTR

Pointeur vers une chaîne Unicode terminée par un caractère Null contenant le nouveau nom.

[in] flags

Type : TRANSFER_SOURCE_FLAGS

Indicateurs qui contrôlent l’opération de fichier. Une ou plusieurs constantes TRANSFER_SOURCE_FLAGS .

[out] ppsiNewDest

Type : IShellItem**

Lorsque cette méthode est retournée, contient l’adresse d’un pointeur vers l’objet IShellItem .

Valeur retournée

Type : HRESULT

Retourne l’un des éléments suivants ou un code d’erreur.

Code de retour	Description
COPYENGINE_S_YES	L’utilisateur a répondu « Oui » à la boîte de dialogue.
COPYENGINE_S_USER_RETRY	L’utilisateur a répondu pour réessayer l’action actuelle.
COPYENGINE_S_USER_IGNORED	L’utilisateur a répondu « Non » à la boîte de dialogue.
COPYENGINE_S_MERGE	L’utilisateur a répondu à des dossiers de fusion.
COPYENGINE_S_USER_RETRY_WITH_NEW_NAME	L’utilisateur a répondu pour réessayer le fichier avec un nouveau nom.
COPYENGINE_S_DONT_PROCESS_CHILDREN	Les éléments enfants ne doivent pas être traités.
COPYENGINE_S_PENDING	L’erreur a été mise en file d’attente et s’affichera ultérieurement.
COPYENGINE_E_USER_CANCELLED	L’utilisateur a annulé l’action en cours.
COPYENGINE_E_REQUIRES_ELEVATION	L’opération nécessite des privilèges élevés.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shobjidl_core.h (incluez Shobjidl.h)

Partager via