Метод IStorage::RenameElement (objidl.h)

Статья
02/29/2024

Метод RenameElement переименовывает указанный вложенный журнал или поток в этом объекте хранилища.

Синтаксис

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

Параметры

[in] pwcsOldName

Указатель на строку Юникода с широким символом, завершающуюся null, которая содержит имя подчиненного или изменяемого потока.

ПримечаниеPwcsName, созданное в CreateStorage или CreateStream , не должно превышать 31 символ в длину, не включая признак конца строки.

[in] pwcsNewName

Указатель на строку Юникода с широким символом, заканчивающуюся null, которая содержит новое имя для указанного подчиненного канала или потока.

Возвращаемое значение

Этот метод может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Элемент был успешно переименован.
E_PENDING	Только асинхронное хранилище. Часть или все данные элемента в настоящее время недоступны.
STG_E_ACCESSDENIED	Вызывающий объект не имеет достаточных разрешений для переименования элемента.
STG_E_FILENOTFOUND	Элемент с указанным старым именем не существует.
STG_E_FILEALREADYEXISTS	Элемент, указанный новым именем, уже существует.
STG_E_INSUFFICIENTMEMORY	Элемент не был переименован из-за нехватки памяти.
STG_E_INVALIDNAME	Недопустимое значение для одного из имен.
STG_E_INVALIDPOINTER	Недопустимый указатель, указанный для элемента .
STG_E_INVALIDPARAMETER	Один из параметров был недопустим.
STG_E_REVERTED	Объект хранилища был признан недействительным в результате операции отменить изменения над ним в дереве транзакций.
STG_E_TOOMANYOPENFILES	Элемент не был переименован, так как открыто слишком много файлов.

IStorage::RenameElement переименовывает указанный вложенный журнал или поток в этом объекте хранилища. Элемент в объекте хранилища нельзя переименовать, пока он открыт. Операция переименования может зафиксировать изменения, если хранилище открыто в режиме транзакций.

Метод IStorage::RenameElement не гарантирует работу при нехватке памяти с объектами хранилища, открытыми в режиме транзакций. Он может работать в прямом режиме.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	objidl.h
Библиотека	Uuid.lib
DLL	Ole32.dll

См. также раздел

IStorage — реализация составного файла