Returns the DISPID and name for each event in a specified range of events.
HRESULT DescribeEvents( ULONG iEvent, ULONG cEvents, DISPID* prgid, BSTR* prgbstr, ULONG* pcEventsFetched );
- iEvent
[in] Index of the first event to retrieve.
- cEvents
[in] Number of events to retrieve.
- prgid
[out] Array of event DISPID values.
- prgbstr
[out] Array of event names.
- pcEventsFetched
[out] The actual number of events fetched.
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
Value | Description |
|---|---|
S_OK | The method succeeded. |
S_FALSE | More events were requested than were available. Unavailable events are represented with DISPID_NULL and a null BSTR. |
E_INVALIDARG | No elements could be fetched. |
This method returns the DISPID and name for each event in a specified range of events.