IOleAdviseHolder::EnumAdvise

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates an enumerator that can be used to enumerate the advisory connections established for an object and supplies a pointer to its IEnumSTATDATA interface.

Syntax

HRESULT EnumAdvise( 
  IENumSTATDATA* ppEnumAdvise
);

Parameters

  • 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 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 Value

This method supports the standard return value E_FAIL, as well as the values described in the following table.

Value Description

S_OK

Enumerator created successfully.

E_NOTIMPL

EnumAdvise is not implemented.

Remarks

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.

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

Requirements

Header Oleidl.h, oleidl.idl
Library oleaut32.lib, uuid.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IOleAdviseHolder
IEnumSTATDATA
IUnknown::Release
STATDATA

Concepts

Determining Supported COM APIs