PipeClient Component

Properties   Methods   Events   Config Settings   Errors  

The PipeClient component is a simple client for connecting and communicating over named pipes.

Syntax

TiipPipeClient

Remarks

The PipeClient component is used to connect to an existing pipe server. After connecting the transfer of data is handled very similarly to socket communication.

To begin, first set PipeName to the name of the pipe to which the connection will be made. Call Connect or set Connected to True to establish the connection. The Connected event will fire when the connection is complete.

After connecting set DataToSend, or call Send or SendFile to send data. Incoming data is received through the DataIn event.

To disconnect call Disconnect or set Connected to False.

Synchronous and Asynchronous Operation

If the Timeout property is set to 0, the component will behave asynchronously and all operations return immediately, potentially failing with an error if they can't be completed immediately.

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

The component 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 component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

Property List


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

AcceptDataThis property enables or disables data reception (the DataIn event).
BytesSentThis property includes the number of bytes actually sent after an assignment to DataToSend .
ConnectedTriggers a connection or disconnection.
DataToSendA string of data to be sent over the connected pipe.
EOLThis property is used to break the incoming data stream into chunks separated by EOL .
PipeNameThe name of the pipe.
RecordLengthThe length of received data records.
SingleLineModeThis property includes a special mode for line-oriented protocols.
TimeoutA 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.

ConfigSets or retrieves a configuration setting.
ConnectConnects to a named pipe.
DisconnectDisconnects from the named pipe.
DoEventsProcesses 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.
SendBytesThis method sends binary data over the connected pipe.
SendFileSends the file over the connected pipe.
SendLineThis method sends a string followed by a newline.
SendTextThis method sends text over the connected pipe.

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.

ConnectedFired immediately after a connection completes.
DataInThis event is fired when data (complete lines) come in.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
ReadyToSendFired when the component is ready to send data.

Config Settings


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

AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
InBufferSizeThe size in bytes of the output buffer.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
OutBufferSizeThe size in bytes of the input buffer.
PipeDirectionDetermines the direction data flows.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AcceptData Property (PipeClient Component)

This property enables or disables data reception (the DataIn event).

Syntax

property AcceptData: Boolean read get_AcceptData write set_AcceptData;

Default Value

true

Remarks

This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, reenables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

BytesSent Property (PipeClient Component)

This property includes the number of bytes actually sent after an assignment to DataToSend .

Syntax

property BytesSent: Integer read get_BytesSent;

Default Value

0

Remarks

This property indicates how many bytes were sent after the last assignment to DataToSend. Please check the DataToSend property 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.

Connected Property (PipeClient Component)

Triggers a connection or disconnection.

Syntax

property Connected: Boolean read get_Connected write set_Connected;

Default Value

false

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the component attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property triggers a connection or disconnection. Setting this property to True makes the component attempt to connect to the pipe identified by the PipeName property. If successful, after the connection is achieved the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection.

This property is not available at design time.

DataToSend Property (PipeClient Component)

A string of data to be sent over the connected pipe.

Syntax

property DataToSend: String write set_DataToSend;
property DataToSendB: TBytes write set_DataToSendB;

Default Value

''

Remarks

Assigning a string to this property makes the component send the string to the server. The Send method provides similar functionality.

When Timeout 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 raises the exception with errorcode 10035 and message '[10035] Operation would block' (WSAEWOULDBLOCK). You can handle this exception, 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).

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

EOL Property (PipeClient Component)

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

Syntax

property EOL: String read get_EOL write set_EOL;
property EOLB: TBytes read get_EOLB write set_EOLB;

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 ('#13#10') 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 ('#13#10') 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.

PipeName Property (PipeClient Component)

The name of the pipe.

Syntax

property PipeName: String read get_PipeName write set_PipeName;

Default Value

''

Remarks

This property specifies the name of the pipe.

This may be the name by itself, for instance "MyPipe", or in the format "\\.\pipe\MyPipe".

RecordLength Property (PipeClient Component)

The length of received data records.

Syntax

property RecordLength: Integer read get_RecordLength write set_RecordLength;

Default Value

0

Remarks

If set to a positive value, this property defines the length of data records to be received. The component will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this property is not used.

This property is not available at design time.

SingleLineMode Property (PipeClient Component)

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

Syntax

property SingleLineMode: Boolean read get_SingleLineMode write set_SingleLineMode;

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

Timeout Property (PipeClient Component)

A timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

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

The component 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 component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 (PipeClient Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (PipeClient Component)

Connects to a named pipe.

Syntax

procedure Connect();

Remarks

This method connects to a named pipe specified by PipeName. Calling this method is equivalent to setting the Connected property to True.

Example (Connecting)

PipeClient.PipeName = "MyPipe"; PipeClient.Connect();

Disconnect Method (PipeClient Component)

Disconnects from the named pipe.

Syntax

procedure Disconnect();

Remarks

This method disconnects from the pipe. Calling this method is equivalent to setting the Connected property to False.

DoEvents Method (PipeClient Component)

Processes events from the internal message queue.

Syntax

procedure DoEvents();

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 (PipeClient Component)

This method gets a line of text from the server.

Syntax

function GetLine(): String;

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

Interrupt Method (PipeClient Component)

This method interrupts the current action.

Syntax

procedure Interrupt();

Remarks

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

Send Method (PipeClient Component)

Sends data over the connected pipe.

Syntax

procedure Send(Text: TBytes);

Remarks

This method sends data to the server. Calling this method is equivalent to setting the DataToSend property to Text.

SendBytes Method (PipeClient Component)

This method sends binary data over the connected pipe.

Syntax

procedure SendBytes(Data: TBytes);

Remarks

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

When Timeout 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 raises the exception with errorcode 10035 and message '[10035] Operation would block' (WSAEWOULDBLOCK). You can handle this exception, 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).

SendFile Method (PipeClient Component)

Sends the file over the connected pipe.

Syntax

procedure SendFile(FileName: String);

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 (PipeClient Component)

This method sends a string followed by a newline.

Syntax

procedure SendLine(Text: String);

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 ('#13#10') .

Please refer to the GetLine method and SingleLineMode property for more information.

SendText Method (PipeClient Component)

This method sends text over the connected pipe.

Syntax

procedure SendText(Text: String);

Remarks

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

When Timeout 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 raises the exception with errorcode 10035 and message '[10035] Operation would block' (WSAEWOULDBLOCK). You can handle this exception, 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).

Connected Event (PipeClient Component)

Fired immediately after a connection completes.

Syntax

type TConnectedEvent = procedure (
  Sender: TObject
) of Object;

property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;

Remarks

When the connection is successfully established this event will fire.

DataIn Event (PipeClient Component)

This event is fired when data (complete lines) come in.

Syntax

type TDataInEvent = procedure (
  Sender: TObject;
  Text: String;
  TextB: TBytes;
  EOL: Boolean
) of Object;

property OnDataIn: TDataInEvent read FOnDataIn write FOnDataIn;

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection. The incoming data are 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).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (PipeClient Component)

Fired when a connection is closed.

Syntax

type TDisconnectedEvent = procedure (
  Sender: TObject
) of Object;

property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;

Remarks

When the connection is closed this event will fire.

Error Event (PipeClient Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

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

ErrorCode contains an error code and Description 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 (PipeClient Component)

Fired when the component is ready to send data.

Syntax

type TReadyToSendEvent = procedure (
  Sender: TObject
) of Object;

property OnReadyToSend: TReadyToSendEvent read FOnReadyToSend write FOnReadyToSend;

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.

Config Settings (PipeClient 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 method.

PipeClient Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

InBufferSize:   The size in bytes of the output buffer.

This setting specifies the size in bytes of the output buffer. Small buffer sizes may reduce overall performance. The default value is "65536".

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The default value is 2048 bytes. The maximum value is 65536 bytes.

OutBufferSize:   The size in bytes of the input buffer.

This setting specifies the size in bytes of the input buffer. Small buffer sizes may reduce overall performance. The default value is "65536".

PipeDirection:   Determines the direction data flows.

Pipe servers are sometimes configured to only send or only receive data (a direction), which can cause Connect to fail if PipeDirection is not set accordingly. Set this to match the direction of the pipe server. Valid values are:

1In. The server can only receive data.
2Out. The server can only send data.
3In/Out (default). The server can both receive and send data.

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 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.
MaskSensitive:   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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component 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.

Setting this setting to True tells the component to use the internal implementation instead of using the system security libraries.

This setting is set to False by default on all platforms.

Trappable Errors (PipeClient Component)

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