IOleAdviseHolder::EnumAdvise

Creates an enumerator that can be used to enumerate the advisory connections currently established for an object, and supplies a pointer to its IEnumSTATDATA interface.

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. A NULL value for *ppenumAdvise indicates that there are presently no advisory connections on the object, or that an error occurred. The advise holder is responsible for incrementing the reference count on the IEnumSTATDATA pointer this method supplies. It is the caller's responsibility to call IUnknown::Release when it is done with the pointer.

Return Values

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

S_OK: Enumerator created successfully.
E_NOTIMPL: EnumAdvise is not implemented.

Remarks

IOleAdviseHolder::EnumAdvise creates an enumerator that can be used to enumerate an object's established advisory connections. The method supplies a pointer to the IEnumSTATDATA interface on this enumerator. Advisory connection information for each connection is stored in the STATDATA structure, and the enumerator must be able to enumerate these structures, defined as follows:

typedef struct tagSTATDATA { 
    FORMATETC         Formatetc; 
    DWORD             grfAdvf; 
    IAdviseSink *     pAdvise; 
    DWORD             dwConnection; 
    }STATDATA;

For this method, the only relevant structure members are pAdvise and dwConnection. Other members contain data advisory information. When you call the enumeration methods, and while an enumeration is in progress, the effect of registering or revoking advisory connections on what is to be enumerated is undefined.

QuickInfo

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