PipeExec Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 to the path of the process on disk. Optionally set ProcessArgs and ProcessWorkingDir.

Call StartProcess to start the process. Next call Send to send data to the process. Received data will be provided through the Stdout and Stderr events.

To terminate the process call StopProcess.

Example Code 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.

AcceptDataEnables or disables data reception (the Stdout and Stderr events).
BytesSentThe number of bytes actually sent after a call to the SendStdinText or SendStdinBytes method.
EOLThis property is used to break the incoming data stream into chunks separated by EOL .
ProcessArgsThe arguments to pass to the process.
ProcessFileNameThe path to the file on disk to execute.
ProcessRunningWhether the process is running.
ProcessWorkingDirThe working directory of the process.
SingleLineModeThis property includes a special mode for line-oriented protocols.
TimeoutThis 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.

ConfigSets or retrieves a configuration setting.
DoEventsThis method processes events from the internal message queue.
GetLineThis method gets a line of text from the server.
InterruptThis method interrupts the current action.
SendSends data over the connected pipe.
SendFileSends the file over the connected pipe.
SendLineThis method sends a string followed by a newline.
SendStdinBytesThis method sends binary data over the connected pipe.
SendStdinTextThis method sends text over the connected pipe.
StartProcessStarts the process.
StopProcessStops 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.

ErrorFired when information is available about errors during data delivery.
ReadyToSendFired when the class is ready to send data.
StderrFired when data come in through stderr.
StdoutFired 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.

LogonTypeSpecifies the logon type when starting a process as another user.
PasswordSpecifies the password when starting a process as another user.
ProcessIdReturns the Id of the process which was started.
ProcessStartupFlagsSpecifies the flags used when starting the process in Windows.
ProcessWindowStyleSpecifies the window style when STARTF_USESHOWWINDOW is specified.
UserSpecifies the user when starting a process as another user.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AcceptData Property (PipeExec Class)

Enables or disables data reception (the Stdout and Stderr events).

Syntax

ANSI (Cross Platform)
int GetAcceptData();
int SetAcceptData(int bAcceptData); Unicode (Windows) BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);
int ipworksipc_pipeexec_getacceptdata(void* lpObj);
int ipworksipc_pipeexec_setacceptdata(void* lpObj, int bAcceptData);
bool GetAcceptData();
int SetAcceptData(bool bAcceptData);

Default Value

TRUE

Remarks

This property enables or disables data reception (the Stdout and Stderr events). Setting this property to False, temporarily disables data reception. Setting this property to True, re-enables data reception.

This property is not available at design time.

Data Type

Boolean

BytesSent Property (PipeExec Class)

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

Syntax

ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();
int ipworksipc_pipeexec_getbytessent(void* lpObj);
int GetBytesSent();

Default Value

0

Remarks

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

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

Data Type

Integer

EOL Property (PipeExec Class)

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

Syntax

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);
int ipworksipc_pipeexec_geteol(void* lpObj, char** lpEOL, int* lenEOL);
int ipworksipc_pipeexec_seteol(void* lpObj, const char* lpEOL, int lenEOL);
QByteArray GetEOL();
int SetEOL(QByteArray qbaEOL);

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 Class)

The arguments to pass to the process.

Syntax

ANSI (Cross Platform)
char* GetProcessArgs();
int SetProcessArgs(const char* lpszProcessArgs); Unicode (Windows) LPWSTR GetProcessArgs();
INT SetProcessArgs(LPCWSTR lpszProcessArgs);
char* ipworksipc_pipeexec_getprocessargs(void* lpObj);
int ipworksipc_pipeexec_setprocessargs(void* lpObj, const char* lpszProcessArgs);
QString GetProcessArgs();
int SetProcessArgs(QString qsProcessArgs);

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 Class)

The path to the file on disk to execute.

Syntax

ANSI (Cross Platform)
char* GetProcessFileName();
int SetProcessFileName(const char* lpszProcessFileName); Unicode (Windows) LPWSTR GetProcessFileName();
INT SetProcessFileName(LPCWSTR lpszProcessFileName);
char* ipworksipc_pipeexec_getprocessfilename(void* lpObj);
int ipworksipc_pipeexec_setprocessfilename(void* lpObj, const char* lpszProcessFileName);
QString GetProcessFileName();
int SetProcessFileName(QString qsProcessFileName);

Default Value

""

Remarks

This property specifies the path to the file on disk that will be executed. ProcessArgs optionally specifies the arguments that will be passed. ProcessWorkingDir 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 Class)

Whether the process is running.

Syntax

ANSI (Cross Platform)
int GetProcessRunning();

Unicode (Windows)
BOOL GetProcessRunning();
int ipworksipc_pipeexec_getprocessrunning(void* lpObj);
bool GetProcessRunning();

Default Value

FALSE

Remarks

This property indicates whether the process specified by ProcessFileName is running.

After calling StartProcess this property returns True. After calling StopProcess this property returns False.

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

Data Type

Boolean

ProcessWorkingDir Property (PipeExec Class)

The working directory of the process.

Syntax

ANSI (Cross Platform)
char* GetProcessWorkingDir();
int SetProcessWorkingDir(const char* lpszProcessWorkingDir); Unicode (Windows) LPWSTR GetProcessWorkingDir();
INT SetProcessWorkingDir(LPCWSTR lpszProcessWorkingDir);
char* ipworksipc_pipeexec_getprocessworkingdir(void* lpObj);
int ipworksipc_pipeexec_setprocessworkingdir(void* lpObj, const char* lpszProcessWorkingDir);
QString GetProcessWorkingDir();
int SetProcessWorkingDir(QString qsProcessWorkingDir);

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 Class)

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

Syntax

ANSI (Cross Platform)
int GetSingleLineMode();
int SetSingleLineMode(int bSingleLineMode); Unicode (Windows) BOOL GetSingleLineMode();
INT SetSingleLineMode(BOOL bSingleLineMode);
int ipworksipc_pipeexec_getsinglelinemode(void* lpObj);
int ipworksipc_pipeexec_setsinglelinemode(void* lpObj, int bSingleLineMode);
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 property is ignored.

When this property is set to True, AcceptData automatically will be set to False. Please refer to the GetLine method for more information.

This property is not available at design time.

Data Type

Boolean

Timeout Property (PipeExec Class)

This property includes the timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksipc_pipeexec_gettimeout(void* lpObj);
int ipworksipc_pipeexec_settimeout(void* lpObj, int iTimeout);
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 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 Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksipc_pipeexec_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, 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 Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int ipworksipc_pipeexec_doevents(void* lpObj);
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 Class)

This method gets a line of text from the server.

Syntax

ANSI (Cross Platform)
char* GetLine();

Unicode (Windows)
LPWSTR GetLine();
char* ipworksipc_pipeexec_getline(void* lpObj);
QString 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 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 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 Class)

This method interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int ipworksipc_pipeexec_interrupt(void* lpObj);
int Interrupt();

Remarks

This method interrupts the current action. If you use SendFile 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.)

Send Method (PipeExec Class)

Sends data over the connected pipe.

Syntax

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

Unicode (Windows)
INT Send(LPCSTR lpText, INT lenText);
int ipworksipc_pipeexec_send(void* lpObj, const char* lpText, int lenText);
int Send(QByteArray qbaText);

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 Class)

Sends the file over the connected pipe.

Syntax

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

Unicode (Windows)
INT SendFile(LPCWSTR lpszFileName);
int ipworksipc_pipeexec_sendfile(void* lpObj, const char* lpszFileName);
int SendFile(const QString& qsFileName);

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 Class)

This method sends a string followed by a newline.

Syntax

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

Unicode (Windows)
INT SendLine(LPCWSTR lpszText);
int ipworksipc_pipeexec_sendline(void* lpObj, const char* lpszText);
int SendLine(const QString& qsText);

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 method and SingleLineMode 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 Class)

This method sends binary data over the connected pipe.

Syntax

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

Unicode (Windows)
INT SendStdinBytes(LPCSTR lpData, INT lenData);
int ipworksipc_pipeexec_sendstdinbytes(void* lpObj, const char* lpData, int lenData);
int SendStdinBytes(QByteArray qbaData);

Remarks

This method sends the specified binary data to the server over Stdin. To send text, use the SendStdinText method instead.

When Timeout 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 property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again. (However, please note that ReadyToSend 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 Class)

This method sends text over the connected pipe.

Syntax

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

Unicode (Windows)
INT SendStdinText(LPCWSTR lpszText);
int ipworksipc_pipeexec_sendstdintext(void* lpObj, const char* lpszText);
int SendStdinText(const QString& qsText);

Remarks

This method sends the specified text to the server over Stdin. To send binary data, use the SendStdinBytes method instead.

When Timeout 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 property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again. (However, please note that ReadyToSend 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 Class)

Starts the process.

Syntax

ANSI (Cross Platform)
int StartProcess();

Unicode (Windows)
INT StartProcess();
int ipworksipc_pipeexec_startprocess(void* lpObj);
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, SendLine, Send.

Data received from the process will be available from the Stdout and Stderr events.

The following properties are applicable when calling this method:

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 Class)

Stops the process.

Syntax

ANSI (Cross Platform)
int StopProcess();

Unicode (Windows)
INT StopProcess();
int ipworksipc_pipeexec_stopprocess(void* lpObj);
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 Class)

Fired when information is available about errors during data delivery.

Syntax

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;
#define EID_PIPEEXEC_ERROR 1

virtual INT IPWORKSIPC_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class PipeExecErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(PipeExecErrorEventParams *e);
// Or, subclass PipeExec and override this emitter function. virtual int FireError(PipeExecErrorEventParams *e) {...}

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

ReadyToSend Event (PipeExec Class)

Fired when the class is ready to send data.

Syntax

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;
#define EID_PIPEEXEC_READYTOSEND 2

virtual INT IPWORKSIPC_CALL FireReadyToSend();
class PipeExecReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ReadyToSend(PipeExecReadyToSendEventParams *e);
// Or, subclass PipeExec and override this emitter function. virtual int FireReadyToSend(PipeExecReadyToSendEventParams *e) {...}

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 Class)

Fired when data come in through stderr.

Syntax

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;
#define EID_PIPEEXEC_STDERR 3

virtual INT IPWORKSIPC_CALL FireStderr(LPSTR &lpText, INT &lenText, BOOL &bEOL);
class PipeExecStderrEventParams {
public:
  const QByteArray &Text();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Stderr(PipeExecStderrEventParams *e);
// Or, subclass PipeExec and override this emitter function. virtual int FireStderr(PipeExecStderrEventParams *e) {...}

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 Class)

Fired when data come in through stdout.

Syntax

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;
#define EID_PIPEEXEC_STDOUT 4

virtual INT IPWORKSIPC_CALL FireStdout(LPSTR &lpText, INT &lenText, BOOL &bEOL);
class PipeExecStdoutEventParams {
public:
  const QByteArray &Text();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Stdout(PipeExecStdoutEventParams *e);
// Or, subclass PipeExec and override this emitter function. virtual int FireStdout(PipeExecStdoutEventParams *e) {...}

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 string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of a data portion of length larger than MaxLineLength with no EOL 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 property is "" (empty string), then EOL can be disregarded (it is always True).

Config Settings (PipeExec 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 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 is set, LogonType must also be set. If User is not set, this value will be ignored. Possible values are:

2LOGON32_LOGON_INTERACTIVE
3LOGON32_LOGON_NETWORK
4LOGON32_LOGON_BATCH
5LOGON32_LOGON_SERVICE
7LOGON32_LOGON_UNLOCK
8LOGON32_LOGON_NETWORK_CLEARTEXT
9LOGON32_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 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 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:

0x00000040STARTF_FORCEONFEEDBACK
0x00000080STARTF_FORCEOFFFEEDBACK
0x00002000STARTF_PREVENTPINNING
0x00000020STARTF_RUNFULLSCREEN
0x00001000STARTF_TITLEISAPPID
0x00000800STARTF_TITLEISLINKNAME
0x00000008STARTF_USECOUNTCHARS
0x00000010STARTF_USEFILLATTRIBUTE
0x00000200STARTF_USEHOTKEY
0x00000004STARTF_USEPOSITION
0x00000001 (default)STARTF_USESHOWWINDOW
0x00000002STARTF_USESIZE
0x00000100 (default)STARTF_USESTDHANDLES

ProcessWindowStyle:   Specifies the window style when STARTF_USESHOWWINDOW is specified.

When 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
1SW_SHOWNORMAL
2SW_SHOWMINIMIZED
3SW_SHOWMAXIMIZED
4SW_SHOWNOACTIVATE
5SW_SHOW
6SW_MINIMIZE
7SW_SHOWMINNOACTIVE
8SW_SHOWNA
9SW_RESTORE
10SW_SHOWDEFAULT
11SW_FORCEMINIMIZE
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 and 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:

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

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.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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

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

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact 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 section.

Trappable Errors (PipeExec 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.