Méthode IStorage ::RenameElement (objidl.h)

  • Article

La méthode RenameElement renomme le sous-stockage ou le flux spécifié dans cet objet de stockage.

Syntaxe

HRESULT RenameElement(
  [in] const OLECHAR *pwcsOldName,
  [in] const OLECHAR *pwcsNewName
);

Paramètres

[in] pwcsOldName

Pointeur vers une chaîne Unicode terminée par un caractère null large qui contient le nom du sous-stockage ou du flux à modifier.

Note Le pwcsName, créé dans CreateStorage ou CreateStream , ne doit pas dépasser 31 caractères, sans compter la marque de fin de chaîne.
 

[in] pwcsNewName

Pointeur vers une chaîne Unicode terminée par un caractère null large qui contient le nouveau nom du sous-stockage ou du flux spécifié.

Note Le pwcsName, créé dans CreateStorage ou CreateStream , ne doit pas dépasser 31 caractères, sans compter la marque de fin de chaîne.
 

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour Description
S_OK L’élément a été renommé avec succès.
E_PENDING Stockage asynchrone uniquement : une partie ou la totalité des données de l’élément sont actuellement indisponibles.
STG_E_ACCESSDENIED L’appelant ne dispose pas d’autorisations suffisantes pour renommer l’élément.
STG_E_FILENOTFOUND L’élément portant l’ancien nom spécifié n’existe pas.
STG_E_FILEALREADYEXISTS L’élément spécifié par le nouveau nom existe déjà.
STG_E_INSUFFICIENTMEMORY L’élément n’a pas été renommé en raison d’un manque de mémoire.
STG_E_INVALIDNAME Valeur non valide pour l’un des noms.
STG_E_INVALIDPOINTER Le pointeur spécifié pour l’élément n’était pas valide.
STG_E_INVALIDPARAMETER L’un des paramètres n’était pas valide.
STG_E_REVERTED L’objet de stockage a été invalidé par une opération de rétablissement au-dessus de lui dans l’arborescence des transactions.
STG_E_TOOMANYOPENFILES L’élément n’a pas été renommé, car il y a trop de fichiers ouverts.

Remarques

IStorage ::RenameElement renomme le sous-stockage ou le flux spécifié dans cet objet de stockage. Un élément d’un objet de stockage ne peut pas être renommé lorsqu’il est ouvert. L’opération de renommage est soumise à la validation des modifications si le stockage est ouvert en mode transactionné.

Il n’est pas garanti que la méthode IStorage ::RenameElement fonctionne en mémoire insuffisante avec des objets de stockage ouverts en mode transactionné. Il peut fonctionner en mode direct.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête objidl.h
Bibliothèque Uuid.lib
DLL Ole32.dll

Voir aussi

IStorage - Implémentation de fichiers composés