IDebugBreakpoint2::GetOffsetExpression method (dbgeng.h)

Article
02/22/2024

The GetOffsetExpression methods return the expression string that evaluates to the location that triggers a breakpoint.

Syntax

HRESULT GetOffsetExpression(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG ExpressionSize
);

Parameters

[out, optional] Buffer

The expression string that evaluates to the location on the target that triggers the breakpoint. If Buffer is NULL, this information is not returned.

[in] BufferSize

The size, in characters, of the buffer that Buffer points to.

[out, optional] ExpressionSize

The size, in characters, of the expression string. If ExpressionSize is NULL, this information is not returned.

Return value

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful, but the buffer was not large enough to hold the expression string and so the string was truncated to fit.

This method can also return error values. For more information, see Return Values.

Remarks

The expression is evaluated every time that a module is loaded or unloaded. If the debugger cannot evaluate the expression (for example, if the expression contains a symbol that cannot be interpreted), the breakpoint is flagged as deferred. (For more information about deferred breakpoints, see Controlling Breakpoint Flags and Parameters.)

The GetParameters method also returns the size of the expression string that specifies the location that triggers the breakpoint, ExpressionSize.

For more information about how to use breakpoints, see Using Breakpoints.

Requirements

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

Share via