xtd::diagnostics::debugger Class Reference

Inheritance diagram for xtd::diagnostics::debugger:

Definition

Enables communication with a debugger. This class cannot be inherited.

class core_export_ debugger static_

Inheritance

xtd::static_object → xtd::diagnostics::debugger

Header

#include <xtd/diagnostics/debugger>

Namespace

xtd::diagnostics

Library

xtd.core

Public Static Methods
static auto	is_attached () -> bool
	Gets a value that indicates whether a debugger is attached to the process.
static auto	debug_break () -> void
	Signals a breakpoint to an attached debugger.
static auto	is_logging () -> bool
	Checks to see if logging is enabled by an attached debugger.
static auto	launch () -> bool
	Launches and attaches a debugger to the process.
static auto	log (xtd::int32 level, const xtd::string &category, const xtd::string &message) -> void
	Posts a message for the attached debugger.

Member Function Documentation

is_attached()

auto xtd::diagnostics::debugger::is_attached ( ) -> bool

staticnodiscard

Gets a value that indicates whether a debugger is attached to the process.

Returns

true if a debugger is attached; otherwise, false.

debug_break()

auto xtd::diagnostics::debugger::debug_break ( ) -> void

static

Signals a breakpoint to an attached debugger.

Examples

The following code example demonstrates how to stop the debugger at the call to write_line.

debugger_break_();
console::write_line("Hello, world.");

is_logging()

auto xtd::diagnostics::debugger::is_logging ( ) -> bool

staticnodiscard

Checks to see if logging is enabled by an attached debugger.

Returns

true if a debugger is attached and logging is enabled; otherwise, false.

launch()

auto xtd::diagnostics::debugger::launch ( ) -> bool

staticnodiscard

Launches and attaches a debugger to the process.

Returns

true if the startup is successful or if the debugger is already attached; otherwise, false.

Remarks

If a debugger is already attached, nothing happens.

Debugger launch is only supported on Windows. On Unix and macOS operating systems, the method returns true without launching a debugger.

log()

auto xtd::diagnostics::debugger::log ( xtd::int32 level, const xtd::string & category, const xtd::string & message ) -> void

static

Posts a message for the attached debugger.

Parameters

level	A description of the importance of the message.
category	The category of the message.
message	The message to show.

Remarks

If there is no debugger attached, this method has no effect. The debugger might or might not report the message, depending upon its settings.

Note

The category parameter is limited to 256 characters. std::string longer than 256 characters are truncated.

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/diagnostics/debugger.hpp