IDebugControl3::GetBreakpointParameters method (dbgeng.h)

Article
02/22/2024

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

[in] Count

Specifies the number of breakpoints whose parameters are being requested.

[in, optional] Ids

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.

[in] Start

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.

[out] Params

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 code	Description
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

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