IDebugControl::GetBreakpointParameters method

The GetBreakpointParameters method returns the parameters of one or more breakpoints.

Syntax


HRESULT GetBreakpointParameters(
  [in]           ULONG                        Count,
  [in, optional] PULONG                       Ids,
  [in]           ULONG                        Start,
  [out]          PDEBUG_BREAKPOINT_PARAMETERS Params
);

Parameters

Count [in]

Specifies the number of breakpoints whose parameters are being requested.

Ids [in, optional]

Specifies an array containing the IDs of the breakpoints whose parameters are being requested. The number of items in this array must be equal to the value specified in Count. If Ids is NULL, Start is used instead.

Start [in]

Specifies the beginning index of the breakpoints whose parameters are being requested. The parameters for breakpoints with indices Start through Start plus Count minus one will be returned. Start is used only if Ids is NULL.

Params [out]

Receives the parameters for the specified breakpoints. The size of this array is equal to the value of Count. For details on the structure returned, see DEBUG_BREAKPOINT_PARAMETERS.

Return value

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

Return codeDescription
S_OK

The method was successful.

S_FALSE

The method was successful. However, the parameters for some of the breakpoints were not returned. The parameters that were not returned have their Id field set to DEBUG_ANY_ID.

 

Remarks

Some of the parameters might not be returned. This happens if either a breakpoint could not be found or a breakpoint is private (see GetFlags).

Requirements

Target platform

Header

Dbgeng.h (include Dbgeng.h, Dbgeng.h, or Dbgeng.h)

See also

IDebugControl
IDebugControl2
IDebugControl3
GetParameters
GetBreakpointById
GetBreakpointByIndex

 

 

Send comments about this topic to Microsoft

Show: