IFileOperationProgressSink::PreRenameItem method (shobjidl_core.h)

Performs caller-implemented actions before the rename process for each item begins.

Syntax

HRESULT PreRenameItem(
  [in] DWORD      dwFlags,
  [in] IShellItem *psiItem,
  [in] LPCWSTR    pszNewName
);

Parameters

[in] dwFlags

Type: DWORD

bitwise value that contains flags that control the operation. See TRANSFER_SOURCE_FLAGS for flag descriptions.

[in] psiItem

Type: IShellItem*

Pointer to an IShellItem that specifies the item to be renamed.

[in] pszNewName

Type: LPCWSTR

Pointer to the new display name of the item. This is a null-terminated, Unicode string.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise. In the case of an error value, the rename operation and all subsequent operations pending from the call to IFileOperation are canceled.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)