IConnectionPointContainer::EnumConnectionPoints

Article
06/30/2006

This method creates an enumerator object to iterate through all the connection points supported in the connectable object, one connection point per outgoing IID.

HRESULT EnumConnectionPoints(
  IEnumConnectionPoints** ppEnum 
);

Parameters

ppEnum
[out] Address of IEnumConnectionPoints* pointer variable that receives the interface pointer to the newly created enumerator.

Return Values

This method supports the standard return values E_OUTOFMEMORY and E_UNEXPECTED, as well as the following:

S_OK
The enumerator was successfully created.
E_POINTER
The value in ppEnum is not valid. For example, it can be NULL.

Remarks

Because IEnumConnectionPoints enumerates pointers to IConnectionPoint, the caller must use IConnectionPoint::GetConnectionInterface to determine the interface identifier of the outgoing interface that the connection point supports.

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

Notes to Callers

The caller is responsible for releasing the enumerator by calling (*ppEnum)->Release when it is no longer needed.

Notes to Implementers

Returning E_NOTIMPL is specifically disallowed because, with the exception of type information, there would be no other means through which a caller could find the IIDs of the outgoing interfaces. Because a connectable object typically has a fixed set of known outgoing interfaces, it is straightforward to implement the enumerator on top of a fixed length array of IIDs known at compile time.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Ocidl.h, Ocidl.idl.
Link Library: Ole32.lib, Uuid.lib.

Partager via