IDataAdviseHolder::EnumAdvise

Returns a pointer to an IEnumStatdata interface on an enumeration object that can be used to enumerate the current advisory connections.

HRESULT EnumAdvise(
  IEnumSTATDATA ** ppenumAdvise  //Address of output variable that 
                                 // receives the IEnumSTATDATA 
                                 // interface pointer
);

Parameter

ppenumAdvise: [out] Address of 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 Values

This method supports the standard return value E_OUTOFMEMORY, as well as the following:

S_OK: 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, one of the standard enumerator interfaces that contain the Next, Reset, Clone, and Skip methods, on an enumerator object. 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.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in objidl.h.