Метод IFileOperation::RenameItem (shobjidl_core.h)

Объявляет один элемент, которому будет присвоено новое отображаемое имя.

Синтаксис

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

Параметры

[in] psiItem

Тип: IShellItem*

Указатель на элемент IShellItem , указывающий исходный элемент.

[in] pszNewName

Тип: LPCWSTR

Указатель на новое отображаемое имя элемента. Это строка Юникода, заканчивающаяся null.

[in] pfopsItem

Тип: IFileOperationProgressSink*

Указатель на объект IFileOperationProgressSink , который будет использоваться для уведомлений о состоянии и сбоях. Если вы вызываете IFileOperation::Advise для общей операции, в нее включаются сведения о состоянии хода выполнения и уведомления об ошибках для операции переименования, поэтому присвойте этому параметру значение NULL.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Этот метод не переименовывает элемент, он просто объявляет элемент для переименования. Чтобы переименовать объект, необходимо выполнить по крайней мере последовательность вызовов, описанную здесь:

1. Вызовите метод IFileOperation::RenameItem , чтобы объявить новое имя.
2. Вызовите метод IFileOperation::P erformOperations , чтобы начать операцию переименования.

Требования

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

IFileOperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem