ITransferAdviseSink::PropertyFailure method

Called when there is a failure that involves file properties and user interaction is needed.

Syntax


HRESULT PropertyFailure(
  [in]       IShellItem  *psi,
  [inconst PROPERTYKEY *pkey,
  [in]       HRESULT     hrError
);

Parameters

psi [in]

Type: IShellItem*

A pointer to the IShellItem that caused the failure.

pkey [in]

Type: const PROPERTYKEY*

A value that corresponds to the property that will be lost. A NULL value indicates that all properties were lost.

hrError [in]

Type: HRESULT

The error code generated by the failure. It must be handled by the copy engine.

Return value

Type: HRESULT

Any other HRESULT should be passed up. If the failure is not handled, the return value should be hrError.

Return codeDescription
COPYENGINE_S_USERRETRY

The handler should retry the file operation.

COPYENGINE_S_USERRETRYWITHNEWNAME

The handler should retry the file operation using the name returned in the pszRename buffer.

COPYENGINE_S_OVERWRITE

The user has indicated that the handler should overwrite the existing file.

COPYENGINE_S_RETRYWITHOUTSECURITY

The user has indicated that the handler should try the operation again without the security descriptor.

COPYENGINE_E_USERCANCELLED

The user clicked Cancel. The entire copy job is being terminated. The handler should return this code back to the copy engine.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Show: