Debugging Tools for Windows

GetBreakpointByIndex

The GetBreakpointByIndex and GetBreakpointByIndex2 methods return the breakpoint located at the specified index.

HRESULT
  IDebugControl::GetBreakpointByIndex(
    IN ULONG  Index,
    OUT IDebugBreakpoint * *  Bp
    );

HRESULT
  IDebugControl4::GetBreakpointByIndex2(
    IN ULONG  Index,
    OUT IDebugBreakpoint2 * *  Bp
    );

Parameters

Index
Specifies the zero-based index of the breakpoint to return. This is specific to the current process. The value of Index should be between zero and the total number of breakpoints minus one. The total number of breakpoints can be determined by calling GetNumberBreakpoints.
Bp
Receives the returned breakpoint.

Return Value

S_OK
The method was successful.
E_NOINTERFACE
No breakpoint was found with the given index, or the breakpoint with the given index is private.

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

Interface Version

GetBreakpointByIndex is available in all versions of IDebugControl. GetBreakpointByIndex2 is available in IDebugControl4 and later versions.

Comments

The index and returned breakpoint are specific to the current process. The same index will return a different breakpoint if the current process is changed.

Requirements

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

See Also

GetNumberBreakpoints

Build machine: CAPEBUILD