Skip to content

Latest commit

 

History

History
106 lines (87 loc) · 3.26 KB

nf-shobjidl_core-itransfersource-advise.md

File metadata and controls

106 lines (87 loc) · 3.26 KB
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.ITransferSource.Advise
ITransferSource::Advise (shobjidl_core.h)
Sets up an advisory connection for notifications on the status of file operations. (ITransferSource.Advise)
Advise
Advise method [Windows Shell]
Advise method [Windows Shell]
ITransferSource interface
ITransferSource interface [Windows Shell]
Advise method
ITransferSource.Advise
ITransferSource::Advise
_shell_ITransferSource_Advise
shell.ITransferSource_Advise
shobjidl_core/ITransferSource::Advise
shell\ITransferSource_Advise.htm
shell
5a546603-d409-4c8e-9fa8-892c5c4844e7
12/05/2018
Advise, Advise method [Windows Shell], Advise method [Windows Shell],ITransferSource interface, ITransferSource interface [Windows Shell],Advise method, ITransferSource.Advise, ITransferSource::Advise, _shell_ITransferSource_Advise, shell.ITransferSource_Advise, shobjidl_core/ITransferSource::Advise
shobjidl_core.h
Shobjidl.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Shobjidl.idl
Windows
19H1
ITransferSource::Advise
shobjidl_core/ITransferSource::Advise
c++
APIRef
kbSyntax
COM
shobjidl_core.h
ITransferSource.Advise

ITransferSource::Advise

-description

Sets up an advisory connection for notifications on the status of file operations.

-parameters

-param psink [in]

Type: ITransferAdviseSink*

A pointer to notification interface ITransferAdviseSink to update the calling application using methods on this interface.

-param pdwCookie [out]

Type: DWORD*

A pointer to a returned token that uniquely identifies this connection. The calling application uses this token later to delete the connection by passing it to the ITransferSource::Unadvise method. If the connection was not successfully established, this value is zero.

-returns

Type: HRESULT

Any HRESULTs other than listed indicate a failure.

Return code Description
S_OK
The Interface successfully associated.
E_UNEXPECTED
The handler can only handle one sink interface.

-remarks

Call ITransferSource::Advise before calling any other methods in this interface to enable an advisory session. If not set, the handler should consider it an indication that no feedback is available and to do the "default" operation without consulting the calling application.