IEnumSTATDATA interface
Enumerates the advisory connection information for a data object.
When to implement
IEnumSTATDATA is implemented to enumerate advisory connections. Most applications will not implement this directly, but will use the OLE-provided implementation. Pointers to this implementation are available in two ways:
- In a data object, call CreateDataAdviseHolder to get a pointer to the OLE data advise holder object, and then, to implement IDataObject::EnumDAdvise, call IDataAdviseHolder::EnumAdvise, which creates the enumeration object and supplies a pointer to the implementation of IEnumSTATDATA.
- In a compound document object, call CreateOleAdviseHolder to get a pointer to the OLE advise holder object, and then, to implement IOleObject::EnumAdvise, call IOleAdviseHolder::EnumAdvise, which creates the enumeration object and supplies a pointer to the implementation of IEnumSTATDATA.
When to use
Containers usually call methods that return a pointer to IEnumSTATDATA so the container can use its methods to enumerate the existing advisory connections, and use this information to instruct an object to release each of its advisory connections prior to closing down. IDataObject::EnumDAdvise, IDataAdviseHolder::EnumAdvise, IOleAdviseHolder::EnumAdvise, and IOleCache::EnumCache methods all provide a pointer to IEnumSTATDATA.
Members
The IEnumSTATDATA interface inherits from the IUnknown interface. IEnumSTATDATA also has these types of members:
Methods
The IEnumSTATDATA interface has these methods.
| Method | Description |
|---|---|
| Clone |
Creates a new enumerator that contains the same enumeration state as the current one. |
| Next |
Retrieves the specified number of items in the enumeration sequence. |
| Reset |
Resets the enumeration sequence to the beginning. |
| Skip |
Skips over the specified number of items in the enumeration sequence. |
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
IID |
IID_IEnumSTATDATA is defined as 00000105-0000-0000-C000-000000000046 |
See also
- IDataAdviseHolder::EnumAdvise
- IDataObject::EnumDAdvise
- IOleAdviseHolder::EnumAdvise
- IOleCache::EnumCache