IDataAdviseHolder::EnumAdvise method (objidl.h)

Article
02/22/2024

Returns an object that can be used to enumerate the current advisory connections.

Syntax

HRESULT EnumAdvise(
  [out] IEnumSTATDATA **ppenumAdvise
);

Parameters

[out] ppenumAdvise

A pointer to an IEnumSTATDATA pointer variable that receives the interface pointer to the new enumerator object. If the implementation returns NULL in *ppenumAdvise, there are no connections to advise sinks at this time.

Return value

This method returns S_OK if the enumerator object is successfully instantiated or there are no connections.

Remarks

This method must supply a pointer to an implementation of the IEnumSTATDATA interface. Its methods allow you to enumerate the data stored in an array of STATDATA structures. You get a pointer to the OLE implementation of IDataAdviseHolder through a call to CreateDataAdviseHolder, and then call IDataAdviseHolder::EnumAdvise to implement IDataObject::EnumDAdvise.

Adding more advisory connections while the enumerator object is active has an undefined effect on the enumeration that results from this method.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	objidl.h