# PipeExec Component

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

## Syntax

```text
nsoftware.IPWorksIPC.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-component) to the path of the process on disk. Optionally set [ProcessArgs](#processargs-property-pipeexec-component) and [ProcessWorkingDir](#processworkingdir-property-pipeexec-component).

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

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

**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 component with short descriptions. Click on the links for further details.*

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

## Method List

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

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

## Event List

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

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

## Config Settings

*The following is a list of config settings for the component 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. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component 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-component) Component)

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

## Syntax

```text
public bool AcceptData { get; }
```

## 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-component) and [Stderr](#stderr-event-pipeexec-component) events will not fire. Use the [PauseData](#pausedata-method-pipeexec-component) and [ProcessData](#processdata-method-pipeexec-component) methods to control data reception.

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

# BytesSent Property ([PipeExec](#pipeexec-component) Component)

The number of bytes actually sent after a call to the [SendStdinText](#sendstdintext-method-pipeexec-component) or [SendStdinBytes](#sendstdinbytes-method-pipeexec-component) method.

## Syntax

```text
public int BytesSent { get; }
```

## Default Value

0

## Remarks

This property indicates how many bytes were sent after the last call to [SendStdinText](#sendstdintext-method-pipeexec-component) or [SendStdinBytes](#sendstdinbytes-method-pipeexec-component). Please check the [SendStdinText](#sendstdintext-method-pipeexec-component) or [SendStdinBytes](#sendstdinbytes-method-pipeexec-component) 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-component) property is set to a positive value.)

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

# EOL Property ([PipeExec](#pipeexec-component) Component)

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

## Syntax

```text
public string EOL { get; set; }
public byte[] EOLB { get; set; }
```

## 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.

# ProcessArgs Property ([PipeExec](#pipeexec-component) Component)

The arguments to pass to the process

## Syntax

```text
public string ProcessArgs { get; set; }
```

## 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.

# ProcessFileName Property ([PipeExec](#pipeexec-component) Component)

The path to the file on disk to execute.

## Syntax

```text
public string ProcessFileName { get; set; }
```

## Default Value

""

## Remarks

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

This property is not available at design time.

# ProcessRunning Property ([PipeExec](#pipeexec-component) Component)

Whether the process is running.

## Syntax

```text
public bool ProcessRunning { get; }
```

## Default Value

False

## Remarks

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

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

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

# ProcessWorkingDir Property ([PipeExec](#pipeexec-component) Component)

The working directory of the process.

## Syntax

```text
public string ProcessWorkingDir { get; set; }
```

## Default Value

""

## Remarks

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

This property is not available at design time.

# SingleLineMode Property ([PipeExec](#pipeexec-component) Component)

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

## Syntax

```text
public bool SingleLineMode { get; set; }
```

## Default Value

False

## Remarks

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

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

This property is not available at design time.

# Timeout Property ([PipeExec](#pipeexec-component) Component)

This property includes the timeout for the component.

## Syntax

```text
public int Timeout { get; set; }
```

## Default Value

60

## Remarks

This property defines the timeout when sending data. When SSLEnabled is False a value of 0 means data will be sent asynchronously and a positive value means data is sent synchronously. When SSLEnabled is True all data is sent synchronously regardless of the Timeout value. Please see the notes below for details.

**Plaintext**

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 component will wait for the operation to complete before returning control. The component will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds.

**SSL**

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

**Additional Notes**

The component will use [DoEvents](#doevents-method-pipeexec-component) 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 component throws an exception.

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.

# Config Method ([PipeExec](#pipeexec-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoEvents Method ([PipeExec](#pipeexec-component) Component)

This method processes events from the internal message queue.

## Syntax

```text
public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);
```

## Remarks

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

# GetLine Method ([PipeExec](#pipeexec-component) Component)

This method gets a line of text from the server.

## Syntax

```text
public string GetLine();

Async Version
public async Task<string> GetLine();
public async Task<string> GetLine(CancellationToken cancellationToken);
```

## 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 component will block if necessary and then will return the received line. [AcceptData](#acceptdata-property-pipeexec-component) 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-component) property for more information.

# Interrupt Method ([PipeExec](#pipeexec-component) Component)

This method interrupts the current action.

## Syntax

```text
public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);
```

## Remarks

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

# PauseData Method ([PipeExec](#pipeexec-component) Component)

This method pauses data reception.

## Syntax

```text
public void PauseData();

Async Version
public async Task PauseData();
public async Task PauseData(CancellationToken cancellationToken);
```

## Remarks

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

# ProcessData Method ([PipeExec](#pipeexec-component) Component)

This method reenables data reception after a call to PauseData.

## Syntax

```text
public void ProcessData();

Async Version
public async Task ProcessData();
public async Task ProcessData(CancellationToken cancellationToken);
```

## Remarks

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

# Send Method ([PipeExec](#pipeexec-component) Component)

Sends data over the connected pipe.

## Syntax

```text
public void Send(byte[] text);

Async Version
public async Task Send(byte[] text);
public async Task Send(byte[] text, CancellationToken cancellationToken);
```

## Remarks

This method sends data to the server.

# SendFile Method ([PipeExec](#pipeexec-component) Component)

Sends the file over the connected pipe.

## Syntax

```text
public void SendFile(string fileName);

Async Version
public async Task SendFile(string fileName);
public async Task SendFile(string fileName, CancellationToken cancellationToken);
```

## 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 component will operate synchronously.

# SendLine Method ([PipeExec](#pipeexec-component) Component)

This method sends a string followed by a newline.

## Syntax

```text
public void SendLine(string text);

Async Version
public async Task SendLine(string text);
public async Task SendLine(string text, CancellationToken cancellationToken);
```

## 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-component) method and [SingleLineMode](#singlelinemode-property-pipeexec-component) property for more information.

# SendStdinBytes Method ([PipeExec](#pipeexec-component) Component)

This method sends binary data over the connected pipe.

## Syntax

```text
public void SendStdinBytes(byte[] data);

Async Version
public async Task SendStdinBytes(byte[] data);
public async Task SendStdinBytes(byte[] data, CancellationToken cancellationToken);
```

## Remarks

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

When [Timeout](#timeout-property-pipeexec-component) is set to 0 the component 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 component fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeexec-component) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeexec-component) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeexec-component) is not fired when part of the data is successfully sent).

# SendStdinText Method ([PipeExec](#pipeexec-component) Component)

This method sends text over the connected pipe.

## Syntax

```text
public void SendStdinText(string text);

Async Version
public async Task SendStdinText(string text);
public async Task SendStdinText(string text, CancellationToken cancellationToken);
```

## Remarks

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

When [Timeout](#timeout-property-pipeexec-component) is set to 0 the component 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 component fails with exception 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The [BytesSent](#bytessent-property-pipeexec-component) property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-pipeexec-component) event before attempting to send data again. (However, please note that [ReadyToSend](#readytosend-event-pipeexec-component) is not fired when part of the data is successfully sent).

# StartProcess Method ([PipeExec](#pipeexec-component) Component)

Starts the process.

## Syntax

```text
public void StartProcess();

Async Version
public async Task StartProcess();
public async Task StartProcess(CancellationToken cancellationToken);
```

## 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-component), [SendLine](#sendline-method-pipeexec-component), [Send](#send-method-pipeexec-component).

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

The following properties are applicable when calling this method:

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

# StopProcess Method ([PipeExec](#pipeexec-component) Component)

Stops the process.

## Syntax

```text
public void StopProcess();

Async Version
public async Task StopProcess();
public async Task StopProcess(CancellationToken cancellationToken);
```

## Remarks

This method stops the process.

# Error Event ([PipeExec](#pipeexec-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PipeExecErrorEventArgs e);

public class PipeExecErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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-component) section.

# ReadyToSend Event ([PipeExec](#pipeexec-component) Component)

Fired when the component is ready to send data.

## Syntax

```text
public event OnReadyToSendHandler OnReadyToSend;

public delegate void OnReadyToSendHandler(object sender, PipeExecReadyToSendEventArgs e);

public class PipeExecReadyToSendEventArgs : EventArgs {
}
```

## 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-component) Component)

Fired when data come in through stderr.

## Syntax

```text
public event OnStderrHandler OnStderr;

public delegate void OnStderrHandler(object sender, PipeExecStderrEventArgs e);

public class PipeExecStderrEventArgs : EventArgs {
  public string Text { get; }  public byte[] TextB { get; }
  public bool EOL { get; }
}
```

## 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-component) Component)

Fired when data come in through stdout.

## Syntax

```text
public event OnStdoutHandler OnStdout;

public delegate void OnStdoutHandler(object sender, PipeExecStdoutEventArgs e);

public class PipeExecStdoutEventArgs : EventArgs {
  public string Text { get; }  public byte[] TextB { get; }
  public bool EOL { get; }
}
```

## 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-component) string was found at the end of *Text*. If the [EOL](#eol-property-pipeexec-component) 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-component) 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-component) property is "" (empty string), then *EOL* can be disregarded (it is always True).

# Config Settings ([PipeExec](#pipeexec-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-pipeexec-component) 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-component) and will return the Id of the process which was started. This may be useful for inspecting or monitoring the process outside of the component.

**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.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component 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*.

**UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component 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.

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 components 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 component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component 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.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([PipeExec](#pipeexec-component) Component)

### 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. |