IFileOperation::RenameItem 方法 (shobjidl_core.h)

声明一个项,该项将被赋予新的显示名称。

语法

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

参数

[in] psiItem

类型: IShellItem*

指向指定源项的 IShellItem 的指针。

[in] pszNewName

类型: LPCWSTR

指向项的新 显示名称 的指针。 这是以 null 结尾的 Unicode 字符串。

[in] pfopsItem

类型: IFileOperationProgressSink*

指向要用于状态和失败通知的 IFileOperationProgressSink 对象的指针。 如果为整体操作调用 IFileOperation::Advise ,则会包含重命名操作的进度状态和错误通知,因此请将此参数设置为 NULL

返回值

类型: HRESULT

如果该方法成功,则返回 S_OK。 否则,将返回 HRESULT 错误代码。

注解

此方法不会重命名项,只是声明要重命名的项。 若要重命名对象,必须至少进行此处详述的调用序列:

  1. 调用 IFileOperation::RenameItem 来声明新名称。
  2. 调用 IFileOperation::P erformOperations 开始重命名操作。

要求

   
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 shobjidl_core.h (包括 Shobjidl.h)

另请参阅

IFileOperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem