GetCurrentEventIndex

The GetCurrentEventIndex method returns the index of the current event within the current list of events for the current target, if such a list exists.

HRESULT
  IDebugControl3::GetCurrentEventIndex(
    OUT PULONG  Index
    );

Parameters

Index

Receives the index of the current event in the target. The index will be a number between zero and one less than the number of events returned by GetNumberEvents. The index of the first event is zero.

Return Value

S_OK

The method was successful.

This method may also return error values. See Return Values for more details.

Interface Version

GetCurrentEventIndex is available in IDebugControl3 and later versions.

Comments

Targets that do not have fixed sets of events will always return zero to Index.

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

GetNumberEvents, SetNextEventIndex