xtd::diagnostics::data_received_event_args Class Reference

#include <data_received_event_args.h>

Definition

Provides data for the xtd::diagnostics::process::output_data_received and xtd::diagnostics::process::error_data_received events.

Namespace

xtd::diagnostics

Library

xtd.core

Remarks

To asynchronously collect the redirected xtd::diagnostics::process::standard_output or xtd::diagnostics::process::standard_error stream output of a process, you must create a method that handles the redirected stream output events. The event-handler method is called when the process writes to the redirected stream. The event delegate calls your event handler with an instance of xtd::diagnostics::data_received_event_args. The xtd::diagnostics::data_received_event_args::data property contains the text line that the process wrote to the redirected stream.

Inherits xtd::event_args.

Public Member Functions
	data_received_event_args ()=default
	Initializes a new instance of the data_received_event_args class.
	data_received_event_args (const xtd::ustring &data)
	Initializes a new instance of the data_received_event_args class.
const xtd::ustring &	data () const
	Gets the line of characters that was written to a redirected Process output stream.
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data.
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

data_received_event_args() [1/2]

xtd::diagnostics::data_received_event_args::data_received_event_args ( )

default

Initializes a new instance of the data_received_event_args class.

data_received_event_args() [2/2]

xtd::diagnostics::data_received_event_args::data_received_event_args ( const xtd::ustring &  data )

inline

Initializes a new instance of the data_received_event_args class.

Parameters

data	The line that was written by an associated Process to its redirected xtd::diagnostics::process::standard_output or xtd::diagnostics::process::standard_error stream.

Member Function Documentation

data()

const xtd::ustring & xtd::diagnostics::data_received_event_args::data ( ) const

inline

Gets the line of characters that was written to a redirected Process output stream.

Returns

true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues.

---

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

• xtd.core/include/xtd/diagnostics/data_received_event_args.h