Skip to content

Latest commit

 

History

History
78 lines (62 loc) · 3.21 KB

nf-ole2-createoleadviseholder.md

File metadata and controls

78 lines (62 loc) · 3.21 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 req.apiset
NF:ole2.CreateOleAdviseHolder
CreateOleAdviseHolder function (ole2.h)
Creates an advise holder object for managing compound document notifications. It returns a pointer to the object's OLE implementation of the IOleAdviseHolder interface.
CreateOleAdviseHolder
CreateOleAdviseHolder function [COM]
_ole_CreateOleAdviseHolder
com.createoleadviseholder
ole2/CreateOleAdviseHolder
com\createoleadviseholder.htm
com
f76e074e-6814-4735-9417-d5970e73089f
12/05/2018
CreateOleAdviseHolder, CreateOleAdviseHolder function [COM], _ole_CreateOleAdviseHolder, com.createoleadviseholder, ole2/CreateOleAdviseHolder
ole2.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Ole32.lib
Ole32.dll
Windows
19H1
CreateOleAdviseHolder
ole2/CreateOleAdviseHolder
c++
APIRef
kbSyntax
DllExport
Ole32.dll
ext-ms-win-com-ole32-l1-1-3.dll
Ext-MS-Win-Com-Ole32-L1-1-4.dll
CreateOleAdviseHolder
ext-ms-win-com-ole32-l1-1-3 (introduced in Windows 10, version 10.0.10240)

CreateOleAdviseHolder function

-description

Creates an advise holder object for managing compound document notifications. It returns a pointer to the object's OLE implementation of the IOleAdviseHolder interface.

-parameters

-param ppOAHolder [out]

Address of IOleAdviseHolder pointer variable that receives the interface pointer to the new advise holder object.

-returns

This function returns S_OK on success and supports the standard return value E_OUTOFMEMORY.

-remarks

The function CreateOleAdviseHolder creates an instance of an advise holder, which supports the OLE implementation of the IOleAdviseHolder interface. The methods of this interface are intended to be used to implement the advisory methods of IOleObject, and, when advisory connections have been set up with objects supporting an advisory sink, to send notifications of changes in the object to the advisory sink. The advise holder returned by CreateOleAdviseHolder will suffice for the great majority of applications. The OLE-provided implementation does not, however, support IOleAdviseHolder::EnumAdvise, so if you need to use this method, you will need to implement your own advise holder.

-see-also

IOleAdviseHolder

IOleObject