CreateOleAdviseHolder

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function instantiates an advise holder object for managing compound document notifications. It passes out a pointer to the object's OLE implementation of the IOleAdviseHolder interface.

Syntax

WINOLEAPI CreateOleAdviseHolder(
  IOleAdviseHolder FAR* FAR*  ppOAHolder
);

Parameters

• ppOAHolder
  [out] Pointer to IOleAdviseHolder* pointer variable that receives the interface pointer to the new advise holder object.

Return Value

This function returns S_OK if it is successful.

This function returns E_OUTOFMEMORY if it fails.

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 are 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 suffices for most applications.

However, the OLE-provided implementation does not support IOleAdviseHolder::EnumAdvise. If you need to use this method, implement your own advise holder.

Passing invalid (and under some circumstances NULL) pointers into this function causes an unexpected termination of the application.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

See Also

Reference

Automation Functions
IOleAdviseHolder
IOleObject
IOleAdviseHolder::EnumAdvise

Concepts

Determining Supported COM APIs