xtd 0.2.0
Loading...
Searching...
No Matches
xtd::diagnostics::data_received_event_args Class Referencefinal
Inheritance diagram for xtd::diagnostics::data_received_event_args:
xtd::event_args xtd::object

Definition

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

Provides data for the xtd::diagnostics::process::output_data_received and xtd::diagnostics::process::...
Definition data_received_event_args.h:28
Represents the base class for classes that contain event data, and provides a value to use for events...
Definition event_args.h:18
Inheritance
xtd::objectxtd::event_argsxtd::diagnostics::data_received_event_args
Header
#include <xtd/diagnostics/data_received_event_args>
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.

Public Constructors

 data_received_event_args ()=default
 Initializes a new instance of the data_received_event_args class.
 
 data_received_event_args (const xtd::string &data)
 Initializes a new instance of the data_received_event_args class.
 

Public Properties

const xtd::stringdata () const noexcept
 Gets the line of characters that was written to a redirected Process output stream.
 

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.
 
- 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.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &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::string data)
inlineexplicit

Initializes a new instance of the data_received_event_args class.

Parameters
dataThe 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::string & xtd::diagnostics::data_received_event_args::data ( ) const
inlinenoexcept

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: