IDebugControl3::GetCurrentEventIndex method (dbgeng.h)

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.

Syntax

HRESULT GetCurrentEventIndex(
  [out] PULONG Index
);

Parameters

[out] 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

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

Return code Description
S_OK
The method was successful.

Remarks

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

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

GetNumberEvents

IDebugControl3

SetNextEventIndex