PipeServer Control

Properties Methods Events Config Settings Errors

The PipeServer control is a lightweight server control based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

PipeServer

Remarks

PipeServer is the server complement of PipeClient (which is used to create client applications). They share a common design philosophy and interface. PipeServer is as easy to use as PipeClient.

The client connections are identified by a ConnectionId, an id generated by the component to identify each connection. This id is unique to each connection. PipeServer's events also have ConnectionId as a parameter to identify the connection to which they are related.

Our main goal in designing PipeServer was to make it easy to use without sacrificing performance. The control has a minimum of properties, and events: Connected, DataIn, Disconnected, ReadyToSend, and Error.

PipeServer can start to listen on a pipe by setting PipeName and then setting Listening to True. When a client connects the Connected event fires, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to PipeClient. Data is sent by assigning the data string to the DataToSend property.

Property List

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


ConnectionCount	The number of records in the arrays.
AcceptData	Setting this property to false temporarily disables data reception (and the DataIn event) for the connection.
BytesSent	This property shows how many bytes were sent after the last assignment to DataToSend .
Connected	This property is used to disconnect individual connections and/or show their status.
ConnectionId	This property contains an identifier generated by the control to identify each connection.
DataToSend	This property contains a string of data to be sent to the remote host.
EOL	The EOL property is used to define boundaries in the input stream using the value of the property.
MaxLineLength	This property is the size of an internal buffer that holds received data while waiting for an EOL string.
SingleLineMode	This property shows the special mode for line-oriented protocols.
Timeout	This property specifies a timeout for the control.
DefaultEOL	This property includes a default end-of-line (EOL) value to be used by incoming connections.
DefaultMaxLineLength	The property includes the default maximum line length value for inbound connections.
DefaultSingleLineMode	This property tells the control whether or not to treat new connections as line oriented.
DefaultTimeout	This property includes an initial timeout value to be used by incoming connections.
Listening	If True, the control accepts incoming connections.
PipeName	The name of the pipe.

Method List

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


Config	Sets or retrieves a configuration setting.
Disconnect	This method disconnects the specified client.
DoEvents	Processes events from the internal message queue.
Interrupt	This method interrupts a synchronous send to the remote host.
Send	This method sends binary data to the specified client.
SendFile	This method sends the file to the remote host.
SendLine	This method sends a string followed by a new line.
Shutdown	This method shuts down the server.
StartListening	This method starts listening for incoming connections.
StopListening	This method stops listening for new connections.

Event List

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


Connected	Fired immediately after a connection completes.
DataIn	This event is fired when data come in.
Disconnected	Fires when a client disconnects.
Error	This event fires information about errors during data delivery.
ReadyToSend	Fired when the control is ready to send data.

Config Settings

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


CustomSecurityDescription	A custom security descriptor to define access to the pipe.
InBufferSize	The size in bytes of the output buffer.
OutBufferSize	The size in bytes of the input buffer.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

ConnectionCount Property (PipeServer Control)

The number of records in the arrays.

Syntax

pipeservercontrol.ConnectionCount

Default Value

Remarks

This property controls the size of the following arrays:

AcceptData
BytesSent
Connected
ConnectionId
DataToSend
EOL
MaxLineLength
SingleLineMode
Timeout

The array indices start at 0 and end at ConnectionCount - 1.

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

Data Type

Integer

AcceptData Property (PipeServer Control)

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection.

Syntax

pipeservercontrol.AcceptData(ConnectionId)[=boolean]

Default Value

True

Remarks

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. Setting this to true re-enables data reception.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

BytesSent Property (PipeServer Control)

This property shows how many bytes were sent after the last assignment to DataToSend .

Syntax

pipeservercontrol.BytesSent(ConnectionId)

Default Value

Remarks

This property shows how many bytes were sent after the last assignment to DataToSend. Please check DataToSend for more information.

Note: This property will always return 0 when the control is operating in the synchronous mode (i.e., the Timeout property is set to a positive value).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

Integer

Connected Property (PipeServer Control)

This property is used to disconnect individual connections and/or show their status.

Syntax

pipeservercontrol.Connected(ConnectionId)[=boolean]

Default Value

False

Remarks

This property is used to disconnect individual connections and/or show their status.

The Connected property may be set to false to close the connection.

Connected also shows the status of a particular connection (connected/disconnected).

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

ConnectionId Property (PipeServer Control)

This property contains an identifier generated by the control to identify each connection.

Syntax

pipeservercontrol.ConnectionId(ConnectionId)

Default Value

Remarks

This property contains an identifier generated by the control to identify each connection. This identifier is unique to this connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

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

Data Type

String

DataToSend Property (PipeServer Control)

This property contains a string of data to be sent to the remote host.

Syntax

pipeservercontrol.DataToSend(ConnectionId)[=string]

Default Value

Remarks

This property contains a string of data to be sent to the remote host. It is a write-only property.

Assigning a string to the DataToSend makes the control send the string to the remote host. The Send method provides similar functionality.

When Timeout is set to 0, the control will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap 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.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DataToSendB.

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

Data Type

Binary String

EOL Property (PipeServer Control)

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

Syntax

pipeservercontrol.EOL(ConnectionId)[=string]

Default Value

Remarks

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

The EOL property is especially useful with ASCII files. By setting it to CRLF (Chr$(13) & Chr$(10)) , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF (Chr$(13) & Chr$(10)) . bytes are discarded.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .EOLB.

This property is not available at design time.

Data Type

Binary String

MaxLineLength Property (PipeServer Control)

This property is the size of an internal buffer that holds received data while waiting for an EOL string.

Syntax

pipeservercontrol.MaxLineLength(ConnectionId)[=integer]

Default Value

2048

Remarks

This property is the size of an internal buffer that 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 minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Integer

SingleLineMode Property (PipeServer Control)

This property shows the special mode for line-oriented protocols.

Syntax

pipeservercontrol.SingleLineMode(ConnectionId)[=boolean]

Default Value

False

Remarks

This property shows the special mode for line-oriented protocols. When SingleLineMode is True, the control treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The EOL property is ignored.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Boolean

Timeout Property (PipeServer Control)

This property specifies a timeout for the control.

Syntax

pipeservercontrol.Timeout(ConnectionId)[=integer]

Default Value

Remarks

This property specifies a timeout for the control.

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

The control 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 control fails with an error.

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 0 (asynchronous operation).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultEOL Property (PipeServer Control)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

pipeservercontrol.DefaultEOL[=string]

Default Value

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the control accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DefaultEOLB.

Data Type

Binary String

DefaultMaxLineLength Property (PipeServer Control)

The property includes the default maximum line length value for inbound connections.

Syntax

pipeservercontrol.DefaultMaxLineLength[=integer]

Default Value

2048

Remarks

This property controls the default size of an internal buffer that holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes.

Data Type

Integer

DefaultSingleLineMode Property (PipeServer Control)

This property tells the control whether or not to treat new connections as line oriented.

Syntax

pipeservercontrol.DefaultSingleLineMode[=boolean]

Default Value

False

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

Data Type

Boolean

DefaultTimeout Property (PipeServer Control)

This property includes an initial timeout value to be used by incoming connections.

Syntax

pipeservercontrol.DefaultTimeout[=integer]

Default Value

Remarks

This property is used by the control to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer

Listening Property (PipeServer Control)

If True, the control accepts incoming connections.

Syntax

pipeservercontrol.Listening[=boolean]

Default Value

False

Remarks

Use this property to make the control 'listen' (accept connections) on the pipe specified by PipeName. Setting this property to False will make the control stop listening. Please note that this does not close any existing connections.

Note: Use the StartListening and StopListening methods to control whether the control is listening.

This property is not available at design time.

Data Type

Boolean

PipeName Property (PipeServer Control)

The name of the pipe.

Syntax

pipeservercontrol.PipeName[=string]

Default Value

Remarks

This property specifies the name of the pipe on which to accept connections. Clients must use this name when establishing a connection to PipeServer.

Data Type

String

Config Method (PipeServer Control)

Sets or retrieves a configuration setting.

Syntax

pipeservercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

Disconnect Method (PipeServer Control)

This method disconnects the specified client.

Syntax

pipeservercontrol.Disconnect ConnectionId

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (PipeServer Control)

Processes events from the internal message queue.

Syntax

pipeservercontrol.DoEvents

Remarks

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

Interrupt Method (PipeServer Control)

This method interrupts a synchronous send to the remote host.

Syntax

pipeservercontrol.Interrupt ConnectionId

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the control. If you use SendFile to upload a file, the control will run synchronously on that Connection Id until it is completed.

Send Method (PipeServer Control)

This method sends binary data to the specified client.

Syntax

pipeservercontrol.Send ConnectionId, Text

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendFile Method (PipeServer Control)

This method sends the file to the remote host.

Syntax

pipeservercontrol.SendFile ConnectionId, FileName

Remarks

This method sends the file to the client specified by the ConnectionId.

SendLine Method (PipeServer Control)

This method sends a string followed by a new line.

Syntax

pipeservercontrol.SendLine ConnectionId, Text

Remarks

This method is used to send data with line-oriented protocols. The line is followed by CRLF (Chr$(13) & Chr$(10)) .

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

Shutdown Method (PipeServer Control)

This method shuts down the server.

Syntax

pipeservercontrol.Shutdown

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (PipeServer Control)

This method starts listening for incoming connections.

Syntax

pipeservercontrol.StartListening

Remarks

This method begins listening for incoming connections on the pipe specified by PipeName.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (PipeServer Control)

This method stops listening for new connections.

Syntax

pipeservercontrol.StopListening

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (PipeServer Control)

Fired immediately after a connection completes.

Syntax

Sub pipeservercontrol_Connected(ConnectionId As Integer)

Remarks

This event fires immediately after a client connects. The ConnectionId parameter identifies the client connection.

DataIn Event (PipeServer Control)

This event is fired when data come in.

Syntax

Sub pipeservercontrol_DataIn(ConnectionId As Integer, Text As String, EOL As Boolean)

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. 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 the data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that 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 (PipeServer Control)

Fires when a client disconnects.

Syntax

Sub pipeservercontrol_Disconnected(ConnectionId As Integer)

Remarks

This event fires when a client disconnects. The ConnectionId parameters identifies the client that is disconnected.

Error Event (PipeServer Control)

This event fires information about errors during data delivery.

Syntax

Sub pipeservercontrol_Error(ConnectionId As Integer, ErrorCode As Integer, Description As String)

Remarks

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

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.

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (PipeServer Control)

Fired when the control is ready to send data.

Syntax

Sub pipeservercontrol_ReadyToSend(ConnectionId As Integer)

Remarks

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

Config Settings (PipeServer Control)

The control 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 control, access to these internal properties is provided through the Config method.

PipeServer Config Settings

CustomSecurityDescription: A custom security descriptor to define access to the pipe.

Specified in the Security Descriptor Definition Language format. For example, if there is an instance of PipeServer running as a Windows Service, the correct SDDL string must used in the Config method for a Desktop app to access the pipe, like so: PipeServer1.Config("CustomSecurityDescription=D:(A;OICI;GRGW;;;AU)");

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

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

Base Config Settings

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


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

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


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

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 to mask sensitive data. The default is .

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

UseInternalSecurityAPI: Tells the control whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to by default on all platforms.

Trappable Errors (PipeServer Control)

PipeServer Errors


	20402 Failed to create event.
	20403 Failed to create security descriptor.
	20404 Error creating named pipe.
	20405 Error connecting to named pipe.
	20406 Error disconnecting named pipe.
	20409 Error sending data.
	20411 Invalid MaxLineLength value.
	20412 Error reading data.
	20413 Error invoking RegisterWaitForSingleObject.
	20414 Operation would block.
	20415 Named pipe does not exist.
	20416 Named pipe is already connected.
	20417 Error connecting to named pipe.
	20418 Named pipe not connected.
	20420 Unsupported operation, see error message for details.
	20425 Invalid ConnectionID.