IFileOperationProgressSink::PreCopyItem method (shobjidl_core.h)

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

Syntax

HRESULT PreCopyItem(
  [in] DWORD      dwFlags,
  [in] IShellItem *psiItem,
  [in] IShellItem *psiDestinationFolder,
  [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 source item.

[in] psiDestinationFolder

Type: IShellItem*

Pointer to an IShellItem that specifies the destination folder to contain the copy of the item.

[in] pszNewName

Type: LPCWSTR

Pointer to a new name for the item after it has been copied. This is a null-terminated Unicode string and can be NULL. If NULL, the name of the destination item is the same as the source.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise. In the case of an error value, the copy 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)