Export (0) Print
Expand All

IDataAdviseHolder::EnumAdvise method

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

Syntax


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

Parameters

ppenumAdvise [out]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

ObjIdl.h

IDL

ObjIdl.idl

IID

IID_IDataAdviseHolder is defined as 00000110-0000-0000-C000-000000000046

See also

IDataAdviseHolder
IDataObject::EnumDAdvise
IEnumSTATDATA

 

 

Community Additions

ADD
Show:
© 2015 Microsoft