Export (0) Print
Expand All

ITransferSource::RecycleItem method

Recycle the item into the provided recycle location and return the item in its new location.

Syntax


HRESULT RecycleItem(
  [in]   IShellItem *psiSource,
  [in]   IShellItem *psiParentDest,
  [in]   TRANSFER_SOURCE_FLAGS dwDeleteFlags,
  [out]  IShellItem **ppsiNewDest
);

Parameters

psiSource [in]

Type: IShellItem*

A pointer to the IShellItem to be recycled.

psiParentDest [in]

Type: IShellItem*

A pointer to the IShellItem of the recycle location (the new parent of the item).

dwDeleteFlags [in]

Type: TRANSFER_SOURCE_FLAGS

The flags that control the file operation. One or more of the TRANSFER_SOURCE_FLAGS constants.

ppsiNewDest [out]

Type: IShellItem**

When the method returns, contains the address of a pointer to the recycled IShellItem.

Return value

Type: HRESULT

Returns one of the following, or an error code.

Return codeDescription
COPYENGINE_S_YES

User responded "Yes" to the dialog.

COPYENGINE_S_USER_RETRY

User responded to retry the current action.

COPYENGINE_S_USER_IGNORED

User responded "No" to the dialog.

COPYENGINE_S_DONT_PROCESS_CHILDREN

Children items should not be processed.

COPYENGINE_S_PENDING

Error has been queued and will display later.

COPYENGINE_E_USER_CANCELLED

User canceled the current action.

COPYENGINE_E_REQUIRES_ELEVATION

Operation requires elevated privileges.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Community Additions

ADD
Show:
© 2014 Microsoft