ISimpleConnectionPoint::DescribeEvents Method

---

Retrieves the dispatch identifier and name for events.

Syntax

HRESULT DescribeEvents(
    ULONG iEvent,
    ULONG cEvents,
    DISPID *prgid,
    BSTR *prgbstr,
    ULONG *pcEventsFetched
);

Parameters

iEvent

[in] Integer that specifies the first event index.

cEvents

[in] Integer that specifies the number of events about which to retrieve information.

prgid

[out, size_is(cEvents), length_is(*pcEventsFetched)] Address of the list of dispatch identifiers for the events.

prgbstr

[out, size_is(cEvents), length_is(*pcEventsFetched)] Address of the list of event names.

pcEventsFetched

[out] Address of the list of events retrieved.

Return Value

Returns one of the following values:
 

S_OK	Success.
S_FALSE	The enumeration finished, but the requested number of elements is not available.
E_INVALIDARG	No elements could be retrieved.