Edit

IDebugBreakpoint::GetCommand method (dbgeng.h)

  • Article

The GetCommand method returns the command string that is executed when a breakpoint is triggered.

Syntax

HRESULT GetCommand(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG CommandSize
);

Parameters

[out, optional] Buffer

The command string that is executed when the breakpoint is triggered. If Buffer is NULL, this information is not returned.

[in] BufferSize

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

[out, optional] CommandSize

The size of the command string. If CommandSize 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 command string and so the command string was truncated to fit.
 

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

Remarks

The command string is a list of debugger commands that are separated by semicolons. These commands are executed every time that the breakpoint is triggered. The commands are executed before the engine informs any event callbacks that the breakpoint has been triggered.

The GetParameters method also returns the size of the breakpoint's command, CommandSize.

For more information about breakpoint properties, see Controlling Breakpoint Flags and Parameters.

Requirements

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