ITransferAdviseSink::SubStreamFailure method (shobjidl_core.h)

Called when there is a failure that involves secondary streams and user interaction is needed.

Syntax

HRESULT SubStreamFailure(
  [in] IShellItem *psi,
  [in] LPCWSTR    pszStreamName,
  [in] HRESULT    hrError
);

[in] psi

A pointer to the IShellItem that caused the failure.

[in] pszStreamName

Type: LPCWSTR

The name of the data that will be lost in the operation.

[in] hrError

Type: HRESULT

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

Type: HRESULT

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

Return code	Description
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.

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)