Table of Contents

Engine

(NOTE) A process class that asynchronously reads from standard output and standard error and sends out partial read events. Additionally, the full buffer can be stored for each stream. This makes it possible to read the output of a process in a single-threaded context without having to block on output.

Methods Properties Base Classes Derived Classes
Close StandardError referencecountedeventobject
Create StandardInput
IsRunning StandardOutput
Start StoreStandardErrorData
Terminate StoreStandardOutputData
WaitForClose

Properties


StandardError : string

read-only

The cached total results from standard error. Will be empty if StoreStandardErrorData is false.

var StandardError : String

StandardInput : filestream

var StandardInput : FileStream

StandardOutput : string

read-only

The cached total results from standard output. Will be empty if StoreStandardOutputData is false.

var StandardOutput : String

StoreStandardErrorData : boolean

Should the results from standard error be accumulated and stored? If a lot of data is output it may be good to turn this off and use the partial data callback events instead.

var StoreStandardErrorData : Boolean

StoreStandardOutputData : boolean

Should the results from standard output be accumulated and stored? If a lot of data is output it may be good to turn this off and use the partial data callback events instead.

var StoreStandardOutputData : Boolean

Methods


Close : Void

Closes the wrapper around the process, does not close the process launched. |Name|Type|Description| |---|---|---|

function Close()

Create : asyncprocess

static

Construct a new process. This does not start the process. |Name|Type|Description| |---|---|---|

function Create() : AsyncProcess

IsRunning : boolean

Returns true if the process is still running, false otherwise. |Name|Type|Description| |---|---|---|

function IsRunning() : Boolean

Start : boolean

Begins the execution of another process using the given parameters. Throws an exception if the process cannot be started. |Name|Type|Description| |---|---|---| |startInfo|processstartinfo| |

function Start(startInfo : ProcessStartInfo) : Boolean

Terminate : Void

Attempts to manually shut down the process. This is not safe for the other process or what it's handling. |Name|Type|Description| |---|---|---|

function Terminate()

WaitForClose : integer

Waits for a process to close, this will block until the process closes. |Name|Type|Description| |---|---|---|

function WaitForClose() : Integer

WaitForClose : integer

Waits for a process to close up to a given number of milliseconds. This can take up to 3 * milliseconds due to waiting for the output streams to close. |Name|Type|Description| |---|---|---| |milliseconds|integer| |

function WaitForClose(milliseconds : Integer) : Integer