xtd::native::debugger Class Reference

Definition

Contains debugger native API.

Namespace

xtd::native

Library

xtd.core.native

Warning

Internal use only

Protected Static Methods
static void	debug_break ()
	Signals a breakpoint to an attached debugger.
static bool	is_attached ()
	Gets a value that indicates whether a debugger is attached to the process.
static bool	is_logging ()
	Checks to see if logging is enabled by an attached debugger.
static bool	launch ()
	Launches and attaches a debugger to the process.
static int32_t	show_assert_dialog (const std::string &text, const std::string &caption)
	Displays an assert dialog that shows the text.
static void	log (int32_t level, const std::string &category, const std::string &message)
	Posts a message for the attached debugger.

Member Function Documentation

debug_break()

static void xtd::native::debugger::debug_break ( )

staticprotected

Signals a breakpoint to an attached debugger.

Warning

Internal use only

is_attached()

static bool xtd::native::debugger::is_attached ( )

staticprotected

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

Returns

true if a debugger is attached; otherwise, false.

Warning

Internal use only

is_logging()

static bool xtd::native::debugger::is_logging ( )

staticprotected

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

Returns

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

Warning

Internal use only

launch()

static bool xtd::native::debugger::launch ( )

staticprotected

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 operating system. On Unix and macOS operating systems, the method returns true without launching a debugger.

Warning

Internal use only

show_assert_dialog()

static int32_t xtd::native::debugger::show_assert_dialog ( const std::string &  text, const std::string &  caption  )

staticprotected

Displays an assert dialog that shows the text.

Parameters

text	The assert dialog text.
caption	The assert dialog caption.

Returns

The assert dialog result. (see assert_dialog_results.h file).

Remarks

In general the assert dialog is a system message box.

Warning

Internal use only

log()

static void xtd::native::debugger::log ( int32_t  level, const std::string &  category, const std::string &  message  )

staticprotected

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.

Warning

Internal use only

---

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

• xtd.core.native/include/xtd/native/debugger.h