TFTPClient Control

Properties Methods Events Config Settings Errors

The TFTPClient control is used to exchange files with TFTP servers via the TFTP protocol defined in RFC 783.

Syntax

TFTPClient

Remarks

To use the control, first specify the TFTPServer, then a LocalFile and a RemoteFile, and then call GetFile or PutFile. The Transfer event shows the progress of the transfer.

Potential transmission errors and packet loss are managed by the Timeout property, which controls the maximum time to wait for a response from the server, and the MaxRetransmits property, which specifies how many times to resend a failed packet before giving up.

Property List

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


Idle	The current status of the control.
LocalFile	This property includes a file on the local host to transfer the data to or from.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxRetransmits	This property specifies the number of times to retry sending a failed packet before disconnecting.
RemoteFile	This property includes the file on the remote host.
RetransmitTimeout	This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
TFTPPort	This property specifies the User Datagram Protocol (UDP) port where the remote TFTP server is listening.
TFTPServer	This property includes the address of the TFTP server to exchange files with.
Timeout	The timeout for the control.

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.
DoEvents	This method processes events from the internal message queue.
GetFile	This method downloads a RemoteFile from the TFTP server.
Interrupt	This method interrupts the current method.
PutFile	This method uploads a file specified by LocalFile to the TFTP server.
Reset	This method resets the control.

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.


EndTransfer	This event is fired when a file finishes downloading or uploading.
Error	Fired when information is available about errors during data delivery.
StartTransfer	This event fires when a file starts downloading or uploading.
Transfer	This event is fired during the file download or upload.

Config Settings

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


BlockSize	Determines the block size that will be used when transferring a file.
TransferMode	Determines the transfer mode that will be used when transferring a file.
CaptureIPPacketInfo	Used to capture the packet information.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the control binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the control to be active on the same local port.
UseConnection	Determines whether to use a connected socket.
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Idle Property (TFTPClient Control)

The current status of the control.

Syntax

tftpclientcontrol.Idle

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (TFTPClient Control)

This property includes a file on the local host to transfer the data to or from.

Syntax

tftpclientcontrol.LocalFile[=string]

Default Value

Remarks

If GetFile is called, and LocalFile already exists, it is overwritten. If PutFile is called, LocalFile must point to a valid file or an error will be returned.

Data Type

String

LocalHost Property (TFTPClient Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

tftpclientcontrol.LocalHost[=string]

Default Value

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MaxRetransmits Property (TFTPClient Control)

This property specifies the number of times to retry sending a failed packet before disconnecting.

Syntax

tftpclientcontrol.MaxRetransmits[=integer]

Default Value

Remarks

This property allows you to specify the number of times that you would like to try resending the last data packet if the original packet fails.

The RetransmitTimeout determines the wait time (in seconds) between successive retransmissions.

The default value for the MaxRetransmits property is 3.

Data Type

Integer

RemoteFile Property (TFTPClient Control)

This property includes the file on the remote host.

Syntax

tftpclientcontrol.RemoteFile[=string]

Default Value

Remarks

When the GetFile is called, this must be a valid file on the TFTPServer.

Data Type

String

RetransmitTimeout Property (TFTPClient Control)

This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.

Syntax

tftpclientcontrol.RetransmitTimeout[=integer]

Default Value

Remarks

Please refer to the MaxRetransmits property for the number of retransmit efforts before an error is returned.

The default value for the RetransmitTimeout is 5 seconds.

Data Type

Integer

TFTPPort Property (TFTPClient Control)

This property specifies the User Datagram Protocol (UDP) port where the remote TFTP server is listening.

Syntax

tftpclientcontrol.TFTPPort[=integer]

Default Value

Remarks

The TFTPPort is the UDP port on the TFTPServer to send TFTP requests to.

This property is not available at design time.

Data Type

Integer

TFTPServer Property (TFTPClient Control)

This property includes the address of the TFTP server to exchange files with.

Syntax

tftpclientcontrol.TFTPServer[=string]

Default Value

Remarks

To be able to transfer file via TFTP, the remote host must be running TFTP services on port TFTPPort (default 69).

Example. Get a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.GetFile()

Data Type

String

Timeout Property (TFTPClient Control)

The timeout for the control.

Syntax

tftpclientcontrol.Timeout[=integer]

Default Value

Remarks

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

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

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.

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 (TFTPClient Control)

Sets or retrieves a configuration setting.

Syntax

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

DoEvents Method (TFTPClient Control)

This method processes events from the internal message queue.

Syntax

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

GetFile Method (TFTPClient Control)

This method downloads a RemoteFile from the TFTP server.

Syntax

tftpclientcontrol.GetFile

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string).

Example. Get a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.GetFile()

Interrupt Method (TFTPClient Control)

This method interrupts the current method.

Syntax

tftpclientcontrol.Interrupt

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

PutFile Method (TFTPClient Control)

This method uploads a file specified by LocalFile to the TFTP server.

Syntax

tftpclientcontrol.PutFile

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile.

Example. Put a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.PutFile()

Reset Method (TFTPClient Control)

This method resets the control.

Syntax

tftpclientcontrol.Reset

Remarks

This method will reset the control's properties to their default values.

EndTransfer Event (TFTPClient Control)

This event is fired when a file finishes downloading or uploading.

Syntax

Sub tftpclientcontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (TFTPClient Control)

Fired when information is available about errors during data delivery.

Syntax

Sub tftpclientcontrol_Error(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.

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.

StartTransfer Event (TFTPClient Control)

This event fires when a file starts downloading or uploading.

Syntax

Sub tftpclientcontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (TFTPClient Control)

This event is fired during the file download or upload.

Syntax

Sub tftpclientcontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

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.

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

TFTPClient Config Settings

BlockSize: Determines the block size that will be used when transferring a file.

This should be set to the number of bytes the block should be. This configuration setting uses the blocksize option as defined in RFC 2348. The default is 512.

TransferMode: Determines the transfer mode that will be used when transferring a file.

The available modes are as follows:


Value	Description
0 (default)	Binary (Octet)
1	Ascii (Netascii)

UDP Config Settings

CaptureIPPacketInfo: Used to capture the packet information.

If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

Note: This configuration setting is available only in Windows.

DelayHostResolution: Whether the hostname is resolved when RemoteHost is set.

This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If the control will resolve the hostname and the IP address will be present in the RemoteHost property. If , the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time.

The default value is .

DestinationAddress: Used to get the destination address from the packet information.

If CaptureIPPacketInfo is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

Note: This configuration setting is available only in Windows.

DontFragment: Used to set the Don't Fragment flag of outgoing packets.

When set to True, packets sent by the control will have the Don't Fragment flag set. The default value is False.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the control binds.

This configuration setting must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxPacketSize: The maximum length of the packets that can be received.

This configuration setting specifies the maximum size of the datagrams that the control will accept without truncation.

QOSDSCPValue: Used to specify an arbitrary QOS/DSCP setting (optional).

UseConnection must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType: Used to specify QOS/DSCP settings (optional).

UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

Note: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

Note: QOSTrafficType must be set before setting Active to True.

ShareLocalPort: If set to True, allows more than one instance of the control to be active on the same local port.

This option must be set before the control is activated through the Active property or it will have no effect.

The default value for this setting is False.

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether or not the control should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the control will send and receive data to and from the specified destination.

The default value for this setting is False.

UseIPv6: Whether or not to use IPv6.

By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Config Settings

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

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

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

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

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 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: 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 configuration 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 (TFTPClient Control)

TFTPClient Errors

20123	Packet too large.
20124	Wrong response type from server.
20125	Server error. Description contains detailed information.
20126	Invalid server response.
20127	A valid LocalFile must be provided for PUT operations.
20128	Cannot open local file.
20129	Cannot write to local file.
20130	Cannot read local file.
20131	Busy performing the current transfer.
20302	Timeout while waiting for server.
20306	Server error.
20307	Wrong or invalid response type received from server.
20308	Invalid response from server.

The control may also return one of the following error codes, which are inherited from other controls.

UDP Errors

20105	UDP is already Active.
20107	You cannot change the LocalPort while the control is Active.
20108	You cannot change the LocalHost at this time. A connection is in progress.
20110	The control must be Active for this operation.
20113	You cannot change MaxPacketSize while the control is Active.
20114	You cannot change ShareLocalPort option while the control is Active.
20115	You cannot change RemoteHost when UseConnection is set and the control Active.
20116	You cannot change RemotePort when UseConnection is set and the control is Active.
20117	RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number.
20118	You cannot change UseConnection while the control is Active.
20119	Message cannot be longer than MaxPacketSize.
20120	Message too short.
20435	Unable to convert string to selected CodePage.

SSL Errors

20271	Cannot load specified security library.
20272	Cannot open certificate store.
20273	Cannot find specified certificate.
20274	Cannot acquire security credentials.
20275	Cannot find certificate chain.
20276	Cannot verify certificate chain.
20277	Error during handshake.
20281	Error verifying certificate.
20282	Could not find client certificate.
20283	Could not find server certificate.
20284	Error encrypting data.
20285	Error decrypting data.

TCP/IP Errors

25005	[10004] Interrupted system call.
25010	[10009] Bad file number.
25014	[10013] Access denied.
25015	[10014] Bad address.
25023	[10022] Invalid argument.
25025	[10024] Too many open files.
25036	[10035] Operation would block.
25037	[10036] Operation now in progress.
25038	[10037] Operation already in progress.
25039	[10038] Socket operation on nonsocket.
25040	[10039] Destination address required.
25041	[10040] Message is too long.
25042	[10041] Protocol wrong type for socket.
25043	[10042] Bad protocol option.
25044	[10043] Protocol is not supported.
25045	[10044] Socket type is not supported.
25046	[10045] Operation is not supported on socket.
25047	[10046] Protocol family is not supported.
25048	[10047] Address family is not supported by protocol family.
25049	[10048] Address already in use.
25050	[10049] Cannot assign requested address.
25051	[10050] Network is down.
25052	[10051] Network is unreachable.
25053	[10052] Net dropped connection or reset.
25054	[10053] Software caused connection abort.
25055	[10054] Connection reset by peer.
25056	[10055] No buffer space available.
25057	[10056] Socket is already connected.
25058	[10057] Socket is not connected.
25059	[10058] Cannot send after socket shutdown.
25060	[10059] Too many references, cannot splice.
25061	[10060] Connection timed out.
25062	[10061] Connection refused.
25063	[10062] Too many levels of symbolic links.
25064	[10063] File name is too long.
25065	[10064] Host is down.
25066	[10065] No route to host.
25067	[10066] Directory is not empty
25068	[10067] Too many processes.
25069	[10068] Too many users.
25070	[10069] Disc Quota Exceeded.
25071	[10070] Stale NFS file handle.
25072	[10071] Too many levels of remote in path.
25092	[10091] Network subsystem is unavailable.
25093	[10092] WINSOCK DLL Version out of range.
25094	[10093] Winsock is not loaded yet.
26002	[11001] Host not found.
26003	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
26004	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
26005	[11004] Valid name, no data record (check DNS setup).