nf-shobjidl_core-itransferadvisesink-filefailure.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:shobjidl_core.ITransferAdviseSink.FileFailure	ITransferAdviseSink::FileFailure (shobjidl_core.h)	Called when there is a failure and user interaction is needed.	FileFailure FileFailure method [Windows Shell] FileFailure method [Windows Shell] ITransferAdviseSink interface ITransferAdviseSink interface [Windows Shell] FileFailure method ITransferAdviseSink.FileFailure ITransferAdviseSink::FileFailure _shell_ITransferAdviseSink_FileFailure shell.ITransferAdviseSink_FileFailure shobjidl_core/ITransferAdviseSink::FileFailure	shell\ITransferAdviseSink_FileFailure.htm	shell	4adc4e9d-f1d1-438c-bae3-23d1259453a6	12/05/2018	FileFailure, FileFailure method [Windows Shell], FileFailure method [Windows Shell],ITransferAdviseSink interface, ITransferAdviseSink interface [Windows Shell],FileFailure method, ITransferAdviseSink.FileFailure, ITransferAdviseSink::FileFailure, _shell_ITransferAdviseSink_FileFailure, shell.ITransferAdviseSink_FileFailure, shobjidl_core/ITransferAdviseSink::FileFailure	shobjidl_core.h	Shobjidl.h	Windows	Windows Vista [desktop apps only]	Windows Server 2008 [desktop apps only]					Shobjidl.idl								Windows			19H1	ITransferAdviseSink::FileFailure shobjidl_core/ITransferAdviseSink::FileFailure	c++	APIRef kbSyntax	COM	shobjidl_core.h	ITransferAdviseSink.FileFailure

ITransferAdviseSink::FileFailure

-description

Called when there is a failure and user interaction is needed.

-parameters

-param psi [in]

Type: IShellItem*

The IShellItem on which the operation failed.

-param pszItem [in]

Type: LPCWSTR

Optional. A pointer to a null-terminated buffer that contains the name of the file. If this value is NULL, the name given by the psi parameter is used.

-param hrError [in]

Type: HRESULT

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

-param pszRename [in, out]

Type: LPWSTR

Optional. When this method returns, contains a pointer to a null-terminated buffer that contains a new name for the file. The name cannot exceed length cchRename. If this parameter is NULL, no option to rename will be available.

-param cchRename [in]

Type: ULONG

The size of the pszRename buffer, in characters.

-returns

Type: HRESULT

Any other HRESULT should be returned to the calling process. If the failure is not handled, the return value should be hrError.

Return code	Description
COPYENGINE_S_USER_RETRY	The user clicked Retry. The handler should retry the file operation.
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.
COPYENGINE_S_USER_IGNORED	The user clicked Ignore. The handler should skip creating the item and return this code back to the copy engine.