PsSetBreakPoint

Sets a breakpoint.

Syntax

PULSE_STATUS PsSetBreakPoint(
 [in] PPS_ENGINE pEngine,
 [in] uint64_t PhysicalAddress,
 [out, optional] uint16_t* pBreakPointId
);

Parameters

PPS_ENGINE pEngine

An opaque handle to an engine created by the EngCreateEngine function.

uint64_t PhysicalAddress

The physical address of the breakpoint.

uint16_t* pBreakPointId

Receives the breakpoint ID.

Return value

If the function succeeds, the return value is PULSE_STATUS_SUCCESS.

If it fails, it returns one of the PULSE_STATUS values. Possible return codes include, but are not limited to, the following:

PULSE_STATUS_INSUFFICIENT_RESOURCES
0xC0000002		 One of the memory allocations failed during initialization.
PULSE_STATUS_READ_FAILED
0xC0000003		 Transport communication failed during a read operation.
PULSE_STATUS_WRITE_FAILED
0xC0000004		 Transport communication failed during a write operation.
PULSE_STATUS_TIMEOUT
0xC0000007		 Might happen if
  • Transport I/O timed out.
  • No response was received from the debuggee within the request timeout period.
PULSE_STATUS_INVALID_PARAMETER
0xC0000010		 Might happen if
  • The pEngine parameter is NULL.
  • The PhysicalAddress parameter exceeds the maximum addressable value.
PULSE_STATUS_INVALID_PACKET
0xC0000031		 An invalid or unexpected packet was received in response.
PULSE_STATUS_TARGET_NOT_STOPPED
0xC0000045		 An attempt was made to set the breakpoint while the target was running.
PULSE_STATUS_BREAKPOINT_TABLE_FULL
0xC0000102		 The breakpoint count limit has been reached.
PULSE_STATUS_DEVICE_CONNECTION_LOST
0xC0000308		 The connection to the transport was lost. Try restarting the engine or the transport.

Remarks

A breakpoint can be set only at a physical address. As a result, the breakpoint is triggered at all locations to which that physical address is mapped. To prevent a breakpoint from stopping the target at undesired locations, use breakpoint filters. Refer to the PsAddBreakPointFilter function for more information.

A breakpoint can be set only while the target is stopped.

The current maximum breakpoint count is 1024.