IOleAdviseHolder::EnumAdvise method (oleidl.h)

Creates an enumerator that can be used to enumerate the advisory connections currently established for an object.

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. If this parameter is NULL, there are presently no advisory connections on the object, or 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 finished with the pointer.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return code Description
E_FAIL
The enumeration operation has failed.
E_NOTIMPL

IOleAdviseHolder::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.

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.

Requirements

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

See also

IDataAdviseHolder::EnumAdvise

IOleAdviseHolder

IOleAdviseHolder::Advise

IOleAdviseHolder::Unadvise

IOleObject::EnumAdvise

STATDATA