# PipeExec Class

PipeExec provides an easy way to start and interact with a process over Stdin, Stdout, and Stderr.

## Syntax

```text
PipeExec
```

## Remarks

The PipeExec component provides a way to launch a process and then send/receive data to/from the process. To begin set [ProcessFileName](#processfilename-property-pipeexec-class) to the path of the process on disk. Optionally set [ProcessArgs](#processargs-property-pipeexec-class) and [ProcessWorkingDir](#processworkingdir-property-pipeexec-class).

Call [StartProcess](#startprocess-method-pipeexec-class) to start the process. Next call [Send](#send-method-pipeexec-class) to send data to the process. Received data will be provided through the [Stdout](#stdout-event-pipeexec-class) and [Stderr](#stderr-event-pipeexec-class) events.

To terminate the process call [StopProcess](#stopprocess-method-pipeexec-class).

**Example Code**

```text
Pipeexec exec = new Pipeexec();
exec.OnStdout += exec_OnStdout;
exec.ProcessFileName = @"C:\Windows\system32\cmd.exe";
exec.ProcessArgs = "/Q";
exec.StartProcess();

exec.Stdin = "dir" + System.Environment.NewLine;

while (true) //Wait for output
  exec.DoEvents();

static void exec_OnStdout(object sender, PipeexecStdoutEventArgs e)
{
  Console.WriteLine(e.Text);
}
```

## Property List

*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AcceptData](#acceptdata-property-pipeexec-class) | Indicates whether data reception is currently enabled (the Stdout and Stderr events). |
| [BytesSent](#bytessent-property-pipeexec-class) | The number of bytes actually sent after a call to the SendStdinText or SendStdinBytes method. |
| [EOL](#eol-property-pipeexec-class) | This property is used to break the incoming data stream into chunks separated by EOL . |
| [ProcessArgs](#processargs-property-pipeexec-class) | The arguments to pass to the process. |
| [ProcessFileName](#processfilename-property-pipeexec-class) | The path to the file on disk to execute. |
| [ProcessRunning](#processrunning-property-pipeexec-class) | Whether the process is running. |
| [ProcessWorkingDir](#processworkingdir-property-pipeexec-class) | The working directory of the process. |
| [SingleLineMode](#singlelinemode-property-pipeexec-class) | This property includes a special mode for line-oriented protocols. |
| [Timeout](#timeout-property-pipeexec-class) | This property includes the timeout for the class. |

## Method List

*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Config](#config-method-pipeexec-class) | Sets or retrieves a configuration setting. |
| [DoEvents](#doevents-method-pipeexec-class) | This method processes events from the internal message queue. |
| [GetLine](#getline-method-pipeexec-class) | This method gets a line of text from the server. |
| [Interrupt](#interrupt-method-pipeexec-class) | This method interrupts the current action. |
| [PauseData](#pausedata-method-pipeexec-class) | This method pauses data reception. |
| [ProcessData](#processdata-method-pipeexec-class) | This method reenables data reception after a call to PauseData. |
| [Send](#send-method-pipeexec-class) | Sends data over the connected pipe. |
| [SendFile](#sendfile-method-pipeexec-class) | Sends the file over the connected pipe. |
| [SendLine](#sendline-method-pipeexec-class) | This method sends a string followed by a newline. |
| [SendStdinBytes](#sendstdinbytes-method-pipeexec-class) | This method sends binary data over the connected pipe. |
| [SendStdinText](#sendstdintext-method-pipeexec-class) | This method sends text over the connected pipe. |
| [StartProcess](#startprocess-method-pipeexec-class) | Starts the process. |
| [StopProcess](#stopprocess-method-pipeexec-class) | Stops the process. |

## Event List

*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Error](#error-event-pipeexec-class) | Fired when information is available about errors during data delivery. |
| [ReadyToSend](#readytosend-event-pipeexec-class) | Fired when the class is ready to send data. |
| [Stderr](#stderr-event-pipeexec-class) | Fired when data come in through stderr. |
| [Stdout](#stdout-event-pipeexec-class) | Fired when data come in through stdout. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [LogonType](#LogonType) | Specifies the logon type when starting a process as another user. |
| [Password](#Password) | Specifies the password when starting a process as another user. |
| [ProcessId](#ProcessId) | Returns the Id of the process which was started. |
| [ProcessStartupFlags](#ProcessStartupFlags) | Specifies the flags used when starting the process in Windows. |
| [ProcessWindowStyle](#ProcessWindowStyle) | Specifies the window style when STARTF_USESHOWWINDOW is specified. |
| [UseOverlappedMode](#UseOverlappedMode) | Specifies whether to disable the FILE_FLAG_OVERLAPPED flag when creating a new process. |
| [User](#User) | Specifies the user when starting a process as another user. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AcceptData Property ([PipeExec](#pipeexec-class) Class)

Indicates whether data reception is currently enabled (the Stdout and Stderr events).

## Syntax

```text
ANSI (Cross Platform)
int GetAcceptData();

Unicode (Windows)
BOOL GetAcceptData();
```

## Default Value

TRUE

## Remarks

This property indicates whether data reception is currently enabled. When False, data reception is disabled and the [Stdout](#stdout-event-pipeexec-class) and [Stderr](#stderr-event-pipeexec-class) events will not fire. Use the [PauseData](#pausedata-method-pipeexec-class) and [ProcessData](#processdata-method-pipeexec-class) methods to control data reception.

This property is read-only and not available at design time.

## Data Type

Boolean

# BytesSent Property ([PipeExec](#pipeexec-class) Class)

The number of bytes actually sent after a call to the SendStdinText or SendStdinBytes method.

## Syntax

```text
ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();
```

## Default Value

0

## Remarks

This property indicates how many bytes were sent after the last call to [SendStdinText](#sendstdintext-method-pipeexec-class) or [SendStdinBytes](#sendstdinbytes-method-pipeexec-class). Please check the [SendStdinText](#sendstdintext-method-pipeexec-class) or [SendStdinBytes](#sendstdinbytes-method-pipeexec-class) method for more information. Note: that BytesSent will always return 0 when the component is operating in synchronous mode (i.e., the [Timeout](#timeout-property-pipeexec-class) property is set to a positive value.)

This property is read-only and not available at design time.

## Data Type

Integer

# EOL Property ([PipeExec](#pipeexec-class) Class)

This property is used to break the incoming data stream into chunks separated by EOL .

## Syntax

```text
ANSI (Cross Platform)
int GetEOL(char* &lpEOL, int &lenEOL);int SetEOL(const char* lpEOL, int lenEOL);

Unicode (Windows)
INT GetEOL(LPSTR &lpEOL, INT &lenEOL);INT SetEOL(LPCSTR lpEOL, INT lenEOL);
```

## Default Value

""

## Remarks

This property is used to define boundaries in the input stream using the value of the property.

This property is especially useful with ASCII files. Setting it to CRLF (*"\r\n"*) enables the incoming ASCII text stream to split into defined lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF (*"\r\n"*) bytes are discarded.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

## Data Type

Binary String

# ProcessArgs Property ([PipeExec](#pipeexec-class) Class)

The arguments to pass to the process.

## Syntax

```text
ANSI (Cross Platform)
char* GetProcessArgs();int SetProcessArgs(const char* lpszProcessArgs);

Unicode (Windows)
LPWSTR GetProcessArgs();INT SetProcessArgs(LPCWSTR lpszProcessArgs);
```

## Default Value

""

## Remarks

This property specifies the arguments that will be passed to the process when it is started.

This property is not available at design time.

## Data Type

String

# ProcessFileName Property ([PipeExec](#pipeexec-class) Class)

The path to the file on disk to execute.

## Syntax

```text
ANSI (Cross Platform)
char* GetProcessFileName();int SetProcessFileName(const char* lpszProcessFileName);

Unicode (Windows)
LPWSTR GetProcessFileName();INT SetProcessFileName(LPCWSTR lpszProcessFileName);
```

## Default Value

""

## Remarks

This property specifies the path to the file on disk that will be executed. [ProcessArgs](#processargs-property-pipeexec-class) optionally specifies the arguments that will be passed. [ProcessWorkingDir](#processworkingdir-property-pipeexec-class) optionally specifies the working directory in which the process will run.

This property is not available at design time.

## Data Type

String

# ProcessRunning Property ([PipeExec](#pipeexec-class) Class)

Whether the process is running.

## Syntax

```text
ANSI (Cross Platform)
int GetProcessRunning();

Unicode (Windows)
BOOL GetProcessRunning();
```

## Default Value

FALSE

## Remarks

This property indicates whether the process specified by [ProcessFileName](#processfilename-property-pipeexec-class) is running.

After calling [StartProcess](#startprocess-method-pipeexec-class) this property returns True. After calling [StopProcess](#stopprocess-method-pipeexec-class) this property returns False.

This property is read-only and not available at design time.

## Data Type

Boolean

# ProcessWorkingDir Property ([PipeExec](#pipeexec-class) Class)

The working directory of the process.

## Syntax

```text
ANSI (Cross Platform)
char* GetProcessWorkingDir();int SetProcessWorkingDir(const char* lpszProcessWorkingDir);

Unicode (Windows)
LPWSTR GetProcessWorkingDir();INT SetProcessWorkingDir(LPCWSTR lpszProcessWorkingDir);
```

## Default Value

""

## Remarks

This property optionally specifies the working directory in which the process will run.

This property is not available at design time.

## Data Type

String

# SingleLineMode Property ([PipeExec](#pipeexec-class) Class)

This property includes a special mode for line-oriented protocols.

## Syntax

```text
ANSI (Cross Platform)
int GetSingleLineMode();int SetSingleLineMode(int bSingleLineMode);

Unicode (Windows)
BOOL GetSingleLineMode();INT SetSingleLineMode(BOOL bSingleLineMode);
```

## Default Value

FALSE

## Remarks

When this property is set to True, the class treats the incoming data stream as lines separated by carriage return line feed (CRLF), CR, or LF. The [EOL](#eol-property-pipeexec-class) property is ignored.

When this property is set to True, [AcceptData](#acceptdata-property-pipeexec-class) automatically will be set to False. Please refer to the [GetLine](#getline-method-pipeexec-class) method for more information.

This property is not available at design time.

## Data Type

Boolean

# Timeout Property ([PipeExec](#pipeexec-class) Class)

This property includes the timeout for the class.

## Syntax

```text
ANSI (Cross Platform)
int GetTimeout();int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();INT SetTimeout(INT iTimeout);
```

## Default Value

60

## Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use [DoEvents](#doevents-method-pipeexec-class) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

## Data Type

Integer

# Config Method ([PipeExec](#pipeexec-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pipeexec-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-pipeexec-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DoEvents Method ([PipeExec](#pipeexec-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
```

## Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetLine Method ([PipeExec](#pipeexec-class) Class)

This method gets a line of text from the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetLine();

Unicode (Windows)
LPWSTR GetLine();
```

## Remarks

This method gets a line of text from the server. This method is an alternative method of receiving data for line-oriented protocols. The class will block if necessary and then will return the received line. [AcceptData](#acceptdata-property-pipeexec-class) will be set automatically to True when the method is called, and then will be set to False after a line is received.

Please refer to the [SingleLineMode](#singlelinemode-property-pipeexec-class) property for more information.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Interrupt Method ([PipeExec](#pipeexec-class) Class)

This method interrupts the current action.

## Syntax

```text
ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
```

## Remarks

This method interrupts the current action. If you use [SendFile](#sendfile-method-pipeexec-class) to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# PauseData Method ([PipeExec](#pipeexec-class) Class)

This method pauses data reception.

## Syntax

```text
ANSI (Cross Platform)
int PauseData();

Unicode (Windows)
INT PauseData();
```

## Remarks

This method pauses data reception when called. While data reception is paused, the [Stdout](#stdout-event-pipeexec-class) and [Stderr](#stderr-event-pipeexec-class) events will not fire. Call [ProcessData](#processdata-method-pipeexec-class) to reenable data reception.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ProcessData Method ([PipeExec](#pipeexec-class) Class)

This method reenables data reception after a call to PauseData.

## Syntax

```text
ANSI (Cross Platform)
int ProcessData();

Unicode (Windows)
INT ProcessData();
```

## Remarks

This method reenables data reception after a previous call to [PauseData](#pausedata-method-pipeexec-class). When [PauseData](#pausedata-method-pipeexec-class) is called, data reception is disabled and the [Stdout](#stdout-event-pipeexec-class) and [Stderr](#stderr-event-pipeexec-class) events no longer fire. Calling this method reenables data reception.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Send Method ([PipeExec](#pipeexec-class) Class)

Sends data over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int Send(const char* lpText, int lenText);

Unicode (Windows)
INT Send(LPCSTR lpText, INT lenText);
```

## Remarks

This method sends data to the server.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendFile Method ([PipeExec](#pipeexec-class) Class)

Sends the file over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendFile(const char* lpszFileName);

Unicode (Windows)
INT SendFile(LPCWSTR lpszFileName);
```

## Remarks

This method sends the specified file to the server/process over the connected pipe.

Timeout must be set to a positive value so that the class will operate synchronously.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendLine Method ([PipeExec](#pipeexec-class) Class)

This method sends a string followed by a newline.

## Syntax

```text
ANSI (Cross Platform)
int SendLine(const char* lpszText);

Unicode (Windows)
INT SendLine(LPCWSTR lpszText);
```

## Remarks

This method sends a string followed by a newline. This method is used to send data with line-oriented protocols. The line is followed by CRLF (*"\r\n"*) .

Please refer to the [GetLine](#getline-method-pipeexec-class) method and [SingleLineMode](#singlelinemode-property-pipeexec-class) property for more information.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendStdinBytes Method ([PipeExec](#pipeexec-class) Class)

This method sends binary data over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendStdinBytes(const char* lpData, int lenData);

Unicode (Windows)
INT SendStdinBytes(LPCSTR lpData, INT lenData);
```

## Remarks

This method sends the specified binary data to the server over Stdin. To send text, use the [SendStdinText](#sendstdintext-method-pipeexec-class) method instead.

When [Timeout](#timeout-property-pipeexec-class) is set to 0 the class will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeexec-class) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeexec-class) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeexec-class) is not fired when part of the data is successfully sent).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendStdinText Method ([PipeExec](#pipeexec-class) Class)

This method sends text over the connected pipe.

## Syntax

```text
ANSI (Cross Platform)
int SendStdinText(const char* lpszText);

Unicode (Windows)
INT SendStdinText(LPCWSTR lpszText);
```

## Remarks

This method sends the specified text to the server over Stdin. To send binary data, use the [SendStdinBytes](#sendstdinbytes-method-pipeexec-class) method instead.

When [Timeout](#timeout-property-pipeexec-class) is set to 0 the class will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the class fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeexec-class) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeexec-class) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeexec-class) is not fired when part of the data is successfully sent).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StartProcess Method ([PipeExec](#pipeexec-class) Class)

Starts the process.

## Syntax

```text
ANSI (Cross Platform)
int StartProcess();

Unicode (Windows)
INT StartProcess();
```

## Remarks

This method starts the process specified by StartProcess. After starting the process data may be sent to the process by calling [Send](#send-method-pipeexec-class), [SendLine](#sendline-method-pipeexec-class), [Send](#send-method-pipeexec-class).

Data received from the process will be available from the [Stdout](#stdout-event-pipeexec-class) and [Stderr](#stderr-event-pipeexec-class) events.

The following properties are applicable when calling this method:

- [ProcessFileName](#processfilename-property-pipeexec-class) (required)
- [ProcessArgs](#processargs-property-pipeexec-class)
- [ProcessWorkingDir](#processworkingdir-property-pipeexec-class)

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StopProcess Method ([PipeExec](#pipeexec-class) Class)

Stops the process.

## Syntax

```text
ANSI (Cross Platform)
int StopProcess();

Unicode (Windows)
INT StopProcess();
```

## Remarks

This method stops the process.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Error Event ([PipeExec](#pipeexec-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PipeExecErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PipeExecErrorEventParams;

Unicode (Windows)
virtual INT FireError(PipeExecErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PipeExecErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-pipeexec-class) section.

# ReadyToSend Event ([PipeExec](#pipeexec-class) Class)

Fired when the class is ready to send data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadyToSend(PipeExecReadyToSendEventParams *e);
typedef struct {
  int reserved;
} PipeExecReadyToSendEventParams;

Unicode (Windows)
virtual INT FireReadyToSend(PipeExecReadyToSendEventParams *e);
typedef struct {
  INT reserved;
} PipeExecReadyToSendEventParams;
```

## Remarks

The ReadyToSend event indicates that the underlying pipe is ready to accept data again after a failed send. The event is also fired immediately after a connection to the remote host is established.

# Stderr Event ([PipeExec](#pipeexec-class) Class)

Fired when data come in through stderr.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireStderr(PipeExecStderrEventParams *e);
typedef struct {  const char *Text;
  int lenText;  int EOL;
  int reserved;
} PipeExecStderrEventParams;

Unicode (Windows)
virtual INT FireStderr(PipeExecStderrEventParams *e);
typedef struct {  LPCSTR Text;
  INT lenText;  BOOL EOL;
  INT reserved;
} PipeExecStderrEventParams;
```

## Remarks

The Stderr event is fired every time the process outputs a line in its standard output. The incoming data is provided through the *Text* parameter.

# Stdout Event ([PipeExec](#pipeexec-class) Class)

Fired when data come in through stdout.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireStdout(PipeExecStdoutEventParams *e);
typedef struct {  const char *Text;
  int lenText;  int EOL;
  int reserved;
} PipeExecStdoutEventParams;

Unicode (Windows)
virtual INT FireStdout(PipeExecStdoutEventParams *e);
typedef struct {  LPCSTR Text;
  INT lenText;  BOOL EOL;
  INT reserved;
} PipeExecStdoutEventParams;
```

## Remarks

The Stdout event is fired every time the process outputs a line in its standard output. The incoming data is provided through the *Text* parameter.

*EOL* indicates whether or not the [EOL](#eol-property-pipeexec-class) string was found at the end of *Text*. If the [EOL](#eol-property-pipeexec-class) string was found, then *EOL* is True.

If *Text* is part of a data portion of length larger than [MaxLineLength](#MaxLineLength) with no [EOL](#eol-property-pipeexec-class) strings in it, then *EOL* is False. NOTE: This means that one or more DataIn events with *EOL* set to False can be received during a connection.

If the [EOL](#eol-property-pipeexec-class) property is "" (empty string), then *EOL* can be disregarded (it is always True).

# Config Settings ([PipeExec](#pipeexec-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-pipeexec-class) method.

### PipeExec Config Settings

**LogonType**: Specifies the logon type when starting a process as another user.This setting specifies the logon type to use when starting a process as another user. If [User](#User) is set, LogonType must also be set. If User is not set, this value will be ignored. Possible values are:

|  |  |
| --- | --- |
| 2 | LOGON32_LOGON_INTERACTIVE |
| 3 | LOGON32_LOGON_NETWORK |
| 4 | LOGON32_LOGON_BATCH |
| 5 | LOGON32_LOGON_SERVICE |
| 7 | LOGON32_LOGON_UNLOCK |
| 8 | LOGON32_LOGON_NETWORK_CLEARTEXT |
| 9 | LOGON32_LOGON_NEW_CREDENTIALS |

**Password**: Specifies the password when starting a process as another user.This setting specifies the password to use when starting a process as another user. If [User](#User) is set, Password must also be set. If User is not set, this value will be ignored.

**ProcessId**: Returns the Id of the process which was started.This setting may be queried after calling [StartProcess](#startprocess-method-pipeexec-class) and will return the Id of the process which was started. This may be useful for inspecting or monitoring the process outside of the class.

**ProcessStartupFlags**: Specifies the flags used when starting the process in Windows.This setting specifies the Windows defined flags used when creating the process. The default value is 0x00000101 which includes the STARTF_USESTDHANDLES and STARTF_USESHOWWINDOW flags.

This may be set to the binary 'OR' of one or more of the following values:

|  |  |
| --- | --- |
| 0x00000040 | STARTF_FORCEONFEEDBACK |
| 0x00000080 | STARTF_FORCEOFFFEEDBACK |
| 0x00002000 | STARTF_PREVENTPINNING |
| 0x00000020 | STARTF_RUNFULLSCREEN |
| 0x00001000 | STARTF_TITLEISAPPID |
| 0x00000800 | STARTF_TITLEISLINKNAME |
| 0x00000008 | STARTF_USECOUNTCHARS |
| 0x00000010 | STARTF_USEFILLATTRIBUTE |
| 0x00000200 | STARTF_USEHOTKEY |
| 0x00000004 | STARTF_USEPOSITION |
| 0x00000001 (default) | STARTF_USESHOWWINDOW |
| 0x00000002 | STARTF_USESIZE |
| 0x00000100 (default) | STARTF_USESTDHANDLES |

**ProcessWindowStyle**: Specifies the window style when STARTF_USESHOWWINDOW is specified.When [ProcessStartupFlags](#ProcessStartupFlags) is set to include the STARTF_USESHOWWINDOW flag this setting specifies the window style that is used. The default value is 0 (SW_HIDE). Possible values are:

|  |  |
| --- | --- |
| 0 (default) | SW_HIDE |
| 1 | SW_SHOWNORMAL |
| 2 | SW_SHOWMINIMIZED |
| 3 | SW_SHOWMAXIMIZED |
| 4 | SW_SHOWNOACTIVATE |
| 5 | SW_SHOW |
| 6 | SW_MINIMIZE |
| 7 | SW_SHOWMINNOACTIVE |
| 8 | SW_SHOWNA |
| 9 | SW_RESTORE |
| 10 | SW_SHOWDEFAULT |
| 11 | SW_FORCEMINIMIZE |

**UseOverlappedMode**: Specifies whether to disable the FILE_FLAG_OVERLAPPED flag when creating a new process.This setting is *True* by default. If set to *False*, the FILE_FLAG_OVERLAPPED flag will be disabled when creating the standard input/output handles for a new process, resulting in synchronous I/O. In some environments, such as the .NET 4.x runtime, standard input handles created with FILE_FLAG_OVERLAPPED can cause internal calls like WaitForAvailableConsoleInput to block indefinitely.

**User**: Specifies the user when starting a process as another user.This setting specifies the user to impersonate when starting a process as another user. If User is set, [Password](#Password) and [LogonType](#LogonType) must also be set.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-pipeexec-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: [https://github.com/openssl/openssl/blob/master/README-FIPS.md](https://github.com/openssl/openssl/blob/master/README-FIPS.md)

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([PipeExec](#pipeexec-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### PipeExec Errors

|  |  |
| --- | --- |
| 401 | Failed to create event. |
| 402 | Failed to create security descriptor. |
| 403 | Error creating named pipe. |
| 404 | Error connecting to named pipe. |
| 405 | Error disconnecting named pipe. |
| 408 | Error sending data. |
| 410 | Invalid MaxLineLength value. |
| 411 | Error reading data. |
| 412 | Error invoking RegisterWaitForSingleObject. |
| 413 | Operation would block. |
| 414 | Named pipe does not exist. |
| 415 | Named pipe is already connected. |
| 416 | Error connecting to named pipe. |
| 417 | Named pipe not connected. |
| 419 | Unsupported operation, see error message for details. |
| 420 | Failed to create named pipe for Stdin/Stdout/Stderr. |
| 421 | Failed to set handle information for Stdin/Stdout/Stderr. |
| 422 | Failed to create process. |
| 423 | Failed to terminate process. |