IStorage::RenameElement method

The RenameElement method renames the specified substorage or stream in this storage object.

Syntax

HRESULT RenameElement(
  const OLECHAR *pwcsOldName,
  const OLECHAR *pwcsNewName
);

Parameters

pwcsOldName

Pointer to a wide character null-terminated Unicode string that contains the name of the substorage or stream to be changed.

Note  The pwcsName, created in CreateStorage or CreateStream must not exceed 31 characters in length, not including the string terminator.
 

pwcsNewName

Pointer to a wide character null-terminated unicode string that contains the new name for the specified substorage or stream.

Note  The pwcsName, created in CreateStorage or CreateStream must not exceed 31 characters in length, not including the string terminator.
 

Return value

This method can return one of these values.

Remarks

IStorage::RenameElement renames the specified substorage or stream in this storage object. An element in a storage object cannot be renamed while it is open. The rename operation is subject to committing the changes if the storage is open in transacted mode.

The IStorage::RenameElement method is not guaranteed to work in low memory with storage objects open in transacted mode. It may work in direct mode.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header objidl.h
Library Uuid.lib
DLL Ole32.dll

See also

IStorage - Compound File Implementation