IFileTransfer Interface Members

In This Topic

The following tables list the members exposed by IFileTransfer.

Public Properties

	Name	Description
	ConvertEOLToSeparator	This property applies to ASCII transfers to the host.
	ConvertISO7ToRoman8	Returns or specifies whether ISO-7 characters are converted to Roman 8 characters in files you receive. This property is relevant only for ASCII file transfers.
	ConvertMCSToNRC	Returns or specifies whether Multinational Character Set (MCS) characters are converted to National Replacement Set (NRC) characters in files you send. This property is relevant only for ASCII file transfers.
	ConvertNRCToMCS	Returns or specifies whether National Replacement Set (NRC) characters are converted to Multinational Character Set (MCS) characters in files you receive. This property is relevant only for ASCII file transfers.
	ConvertRoman8ToISO7	Returns or specifies whether Roman 8 characters are converted to ISO-7 characters in files you send. This property is relevant only for ASCII file transfers.
	ConvertSeparatorToEOL	Returns or specifies how Reflection handles line separators during ASCII file transfers.
	DeleteTrailingSpaces	This property returns or specifies how Reflection handles trailing spaces during ASCII file transfers.
	FTPCharacterSetTranslationEnabled	Returns or specifies how ASCII character set translations occur during FTP file transfers.
	FTPClearConnectionInformation	Returns or specifies how login information on the FTP tab of the File Transfer Setup dialog box should be cleared from the controls and fields in this tab (and thus not used as login information for, as an example, a new host you wish to log in to).
	FTPFileNamesTranslationEnabled	Returns or specifies whether file name translation occurs during FTP transfers of ASCII files.
	FTPHostName	Returns or specifies the name or IP address of the server for FTP file transfers.
	FTPPassiveMode	Returns or specifies whether Reflection's integrated FTP client sends a PASV command in order to communicate with the server in passive mode (sometimes called PASV mode).
	FTPPassword	Returns or specifies the default password to be used when logging in to an FTP server.
	FTPTransferType	Returns or specifies the transfer type for FTP transfers from the File Transfer dialog box.
	FTPUserName	Returns or specifies the default user name to be used when logging into an FTP server.
	FTPUseSftpStructuredListing	Returns or specifies the data listing style used for SFTP connections to Secure Shell servers.
	FTPUseWRQFTP	Returns or specifies whether to use Reflection FTP for file transfers.
	HostRecordSeparator	Returns or specifies the character to be used in the PC file as a record separator when an ASCII files is transferred from the host.
	KermitAutomaticServer	Returns or specifies how Reflection interacts with the host Kermit program.
	KermitCharacterSetTranslationEnabled	This property affects ASCII transfers from the File Transfer dialog box.
	KermitChecksum	Kermit supports three kinds of error checking: single-byte checksum, double-byte checksum, and three-byte CRC.
	KermitFileNamesTranslationEnabled	Returns or specifies whether the File name translation options on the Translation tab in the File Transfer Setup dialog box are used for Kermit transfers.
	KermitPacketSize	Returns or specifies the desired packet size for Kermit transfers (in bytes).
	KermitReceiveEndCharacter	Returns or specifies the character that indicates the end of a packet of data received from the host.
	KermitReceiveStartCharacter	Returns or specifies the character that indicates the beginning of a packet of data received from the host.
	KermitReceiveStartupCommand	Returns or specifies the command that directs the host Kermit program to receive a file from the local computer.
	KermitSendEndCharacter	Returns or specifies the character that indicates the end of a packet of data sent to the host.
	KermitSendStartCharacter	Returns or specifies the character that indicates the beginning of a packet of data sent to the host.
	KermitSendStartupCommand	Returns or specifies the command that directs the host Kermit program to send one or more files to the local computer.
	KermitServerStartupCommand	Returns or specifies the string sent to the host to start the host Kermit server program, either when the KermitStartServer method is executed, or, if the KermitAutomaticServer property is set to True, as soon as the user initiates a Kermit file transfer from the File Transfer dialog box.
	KermitTransferType	Returns or specifies the transfer type for Kermit transfers.
	KermitWindowSize	If the remote Kermit program supports sliding windows, this property determines the size of a sliding window, in packets.
	Parent	Gets the parent object. The parent is the ITerminal object.
	PCRecordSeparator	Returns or specifies the character that is interpreted as a record separator in a PC ASCII file when it is transferred to the host.
	ReadCtrlZAsEOF	Returns or specifies whether Reflection interprets Ctrl-Z as the end of file marker in ASCII files being sent to the host.
	ReadTabAsSpaces	Returns or specifies whether tab characters in local files are converted to space characters.
	SpacesPerTab	Returns or specifies the number of consecutive spaces that are converted to a single tab character (for WriteSpacesAsTab) or the number of spaces that a single tab character is converted into (for ReadTabAsSpaces).
	TextFileCharacterSet	Returns or specifies whether Reflection uses the ASCII or ANSI character set.
	Transfer8Dot3FilenameCase	Returns or specifies how case is handled in the names of files sent to the host. This property affects WRQ/Reflection, Kermit, and Zmodem transfers, but not Xmodem transfers.
	TransferAutoDetectASCIIExtensionList	Returns or specifies which file extensions should identify files to be transferred as ASCII files during file transfer using the Auto-Detect transfer type. Use "<>" to specify files with no file extension.
	TransferAutoDetectBinaryExtensionList	Returns or specifies which file extensions should identify files to be transferred as binary files during file transfer using the Auto-Detect transfer type. Use "<>" to specify files with no file extension.
	TransferAutoDetectDefaultType	This property affects file transfers using the Auto-Detect transfer feature. It returns or specifies what type of file transfer to use when no transfer type has been associated with the file extension of a file to be transferred.
	TransferAutoDetectImageLabelsExtensionList	Returns or specifies which file extensions should identify files to be transferred between two host computers during file transfer using the Auto-Detect transfer type.
	TransferAutoDetectScanExtensionList	This property affects file transfers using the Auto-Detect transfer feature.
	TransferDefaultProtocol	Five transfer protocols for sending or receiving files are supported.
	TransferDownloadDirectory	Returns or specifies the default folder for transfers to the local computer.
	TransferIfFileExistsDefault	Returns or specifies what should happen with transfers from the File Transfer dialog box if the destination file already exists.
	TransferLogFileName	Returns or specifies the name of the file transfer log file.
	TransferLoggingEnabled	Returns or specifies whether file transfer logging is enabled.
	TransferPresetConfiguration	Returns or specifies a string identifying a preset configuration for file transfer.
	TransferReceiveAs8Dot3	Returns or specifies whether the names of received files are automatically truncated if they do not conform to the 8-dot-3 file naming convention.
	TransferReceiveTimeout	Returns or specifies the maximum number of seconds to wait for a response from the host or Reflection during a transfer.
	TransferRetryLimit	Returns or specifies how many consecutive times to attempt to transmit a packet before abandoning a file transfer.
	TransferSpacesToUnderscores	Returns or specifies whether spaces in file names are converted to underscores when files are sent.
	TransferStartTimeout	Returns or specifies the number of seconds the file transfer program should wait for a response from the host before beginning a transfer. If no response is received within this interval, the program abandons the transfer.
	TransferStatusWindowVisible	Returns or specifies whether the file transfer status window is displayed while a file transfer is occurring.
	TransferUnderscoresToSpaces	Returns or specifies whether underscores in file names are converted to spaces when files are received.
	UseHostRecordSeparator	Returns or specifies whether Reflection uses the record separator character specified by HostRecordSeparator when an ASCII file is transferred from the host.
	UsePCRecordSeparator	Returns or specifies whether Reflection uses the record separator character specified by PCRecordSeparator when an ASCII file is transferred to the host.
	WriteCtrlZAsEOF	When this property is set to True, Reflection automatically adds an end-of-file marker at the end of ASCII files received from the host.
	WriteSpacesAsTab	Returns or specifies whether Reflection replaces spaces with tabs during ASCII file transfers from the host.
	WRQCompression	Returns or specifies how file compression is handled.
	WRQEndOfFrameCharacter	Returns or specifies the character that is to indicate the end of a file transfer frame.
	WRQExtraCharacters	This property is relevant only when WRQTransferLink is set to TransferLinkOption.UserDefinedLink.
	WRQFastCompression	Returns or specifies whether Reflection compresses files transferred using fast file transfer.
	WRQFastFileTransfer	Returns or specifies whether Reflection should attempt to use the fast file transfer feature.
	WRQFrameSize	Returns or specifies the total length of a file transfer packet (in characters), including the start and end characters, but not the delimiting character.
	WRQFrameTerminator	Returns or specifies which character comes at the end of a file transfer packet. This character causes a host read operation to complete.
	WRQHiddenFoldersVisible	Returns or specifies whether hidden folders (with names beginning with a period) on a UNIX host are displayed in the File Transfer dialog box, when the host folder list is displayed.
	WRQHostErrorMessage	Returns the host error message for a failed WRQ/Reflection protocol file transfer.
	WRQHostRecordSize	Returns or specifies the record size (in bytes) for files transferred to the host.
	WRQHostSystem	Returns or specifies the expected type of host. This property is relevant only for transfers that use the WRQ/Reflection protocol.
	WRQKeepFile	Returns or specifies whether a copy of the file being sent should be kept on the host.
	WRQMPEFileNames	Version 5.0 of the MPE operating system .
	WRQMPEStream	Native POSIX files under version 5.0 of the MPE operating system support a record format known as "stream," which is just a stream of bytes.
	WRQPreserveCounts	Returns or specifies whether record byte counts are transferred with data during a binary transfer to the host.
	WRQPreserveDate	Returns or specifies whether the destination file receives its creation date and time from the source file.
	WRQQEditFormat	Returns (first syntax line) or specifies (second syntax line) whether HP 3000 host files are created with the QEDIT format.
	WRQRecordSizeVisible	Returns or specifies whether the Host record size edit control is displayed in the File Transfer dialog box.
	WRQRemoveFileExtension	Returns or specifies whether the DOS file name extension is automatically stripped when files are sent to the host without explicit specification of the host file name.
	WRQSendSpooled	Returns or specifies whether files are sent to a spooled device on the host.
	WRQStartOfFrameCharacter	Returns or specifies which character is to indicate the beginning of a file transfer frame.
	WRQStartupCommand	Returns or specifies the host startup command for the WRQ/Reflection transfer protocol. This property is relevant only for transfers that use the WRQ/Reflection protocol.
	WRQSubmitBatch	Returns or specifies whether a file is submitted to the batch queue upon completion of an ASCII transfer to a VMS host.
	WRQSubmitPrint	Returns or specifies whether a file is submitted to the print queue upon completion of an ASCII transfer to a VMS host.
	WRQTransferLink	Returns or specifies the extent to which nonprinting ASCII characters are automatically converted to printing ASCII characters during file transfers.
	WRQTransferType	Returns or specifies the transfer type for transfers from the File Transfer dialog box.
	WRQTransferWithAttributes	Returns or specifies whether attribute information is included with a file being received from the host.
	WRQTranslateCarriageCtrl	Returns or specifies whether FORTRAN and PRINT carriage control characters in VMS files are translated.
	WRQUseBlockReads	Returns or specifies whether VAXLINK2, the VMS host transfer program, is forced to read files in block mode rather than record mode.
	WRQWindowSize	The WRQ/Reflection file transfer protocol is a sliding-window protocol. This property returns or specifies the number of packets that one side can receive before sending an acknowledgment. For transfers to or from HP 3000 hosts, this property must be set to 1. If WRQFastFileTransfer is True, fast file transfers are attempted. If a fast file transfer takes place, the WRQWindowSize property is ignored. This property is relevant only for transfers that use the WRQ/Reflection protocol.
	XmodemCharacterSetTranslationEnabled	When this property is set to True, Reflection performs the character set translations specified on the Translation tab in the File Transfer Setup dialog box, as well as the translations between the host character set and the PC character set, as specified on the Emulation tab in the Terminal Setup dialog box.
	XmodemExtension	Returns or specifies what type of Xmodem error checking is performed, as well as the Xmodem packet size.
	XmodemTransferType	Returns or specifies the transfer type for Xmodem transfers from the File Transfer dialog box.
	ZmodemAutoDownload	Returns or specifies whether Reflection takes advantage of Zmodem's automatic download feature.
	ZmodemCharacterSetTranslationEnabled	When this property is set to True, Reflection performs the character set translations specified on the Translation tab in the File Transfer Setup dialog box, as well as the translations between the host character set and the PC character set, as specified on the Emulation tab in the Terminal Setup dialog box.
	ZmodemDeleteCancelledReceives	Returns or specifies what happens when you cancel a Zmodem receive.
	ZmodemFileNamesTranslationEnabled	Returns or specifies whether the File name translation options on the Translation tab in the File Transfer Setup dialog box are used for Zmodem transfers.
	ZmodemPacketSize	Returns or specifies the sub-packet size for file transfers to the remote system; this tells Zmodem how many bytes of data to transfer at a time.
	ZmodemReceiveStartupCommand	When you send a file from the PC to the host using the Zmodem protocol, this command is transmitted to the host.
	ZmodemSendStartupCommand	When you initiate a receive from the host using the Zmodem protocol, this command and the host file name are transmitted to the host.
	ZmodemTransferType	Returns or specifies the transfer type for Zmodem transfers from the File Transfer dialog box.

Top

Public Methods

	Name	Description
	AbortTransfer	Aborts a file transfer in progress (for any of the supported transfer protocols: Kermit, WRQ/Reflection, Xmodem, or Zmodem) without communicating with the host program. This method is more drastic than CancelTransfer, and may leave the host in an unpredictable state. Use AbortTransfer only if you believe the host transfer program has stopped responding; otherwise use CancelTransfer. This method is not likely to be useful in a macro because all transfer methods must complete execution before subsequent commands are executed. AbortTransfer can be useful for mapping to custom items such as toolbar buttons, keystrokes or events. You could also use this method if you are using automation. For example, you could use stand-alone Visual Basic .NET to create a form with an Abort button to abort a transfer in progress.
	CancelTransfer	Attempts to cancel a file transfer in progress (for any of the supported transfer protocols: Kermit, WRQ/Reflection, Xmodem, or Zmodem) by shutting down the host program. Use AbortTransfer if you think the host program has stopped responding. This method is not likely to be useful in a macro because all transfer methods must complete execution before subsequent commands are executed. AbortTransfer can be useful for mapping to custom items such as toolbar buttons, keystrokes or events. You can also use this method if you are using automation. For example, you could use stand-alone Visual Basic .NET to create a form with a Cancel Transfer button to cancel a transfer in progress.
	FTPGetCurrentHostDirectory	Returns the current host directory used for FTP file transfers. This method is only valid when Reflection is connected to the host FTP server; use FTPStartServer to connect to the server before using this method.
	FTPReceiveFile	Transfers one or more files from the host to the PC using FTP (file transfer protocol). Use FTPStartServer to connect to the host server before using this method. Use FTPStopServer to disconnect from the host server after file transfer is complete.
	FTPSendFile	Transfers one or more files from the PC to the host using FTP file transfer protocol. Use FTPStartServer to connect to the host server before using this method. Use FTPStopServer to disconnect from the host server after file transfer is complete.
	FTPSetCurrentHostDirectory	Sets the current host directory used for FTP file transfers. This method is only valid when Reflection is connected to the host FTP server; use FTPStartServer to connect to the server before using this method.
	FTPStartServer	Connects to a host server in preparation for FTP file transfers. Use FTPSendFile and FTPReceiveFile to transfer files. Use FTPStopServer to disconnect from the host FTP server. If your settings file is not already configured for FTP protocol, use TransferDefaultProtocol to set the transfer protocol, and TransferPreset to set the host server type. Most menu commands and all toolbar buttons are disabled when Reflection is in server mode.
	FTPStopServer	Disconnects from a host server connected by FTPStartServer.
	KermitReceiveFile	Transfers one or more files from a remote computer running a Kermit program to the local computer, using the Kermit file transfer protocol.
	KermitSendFile	Transfers a file from the local computer to the remote system using the Kermit file transfer protocol. There is no IfFileExists option for this method because that aspect of the transfer is controlled by the remote system.
	KermitStartServer	Starts a remote Kermit program in server mode. The command used to start the server is defined by the KermitServerStartupCommand property. If that command fails to start the remote Kermit program, this method will still set the local flag indicating that the remote program is in server mode.
	KermitStopServer	Instructs a remote Kermit program running in server mode to shut down.
	StartTransferLogging	Initiates file transfer logging. When TransferLoggingEnabled is True (the default value), Reflection stores file transfer information to a log file specified by the TransferLogFileName property. Use StopTransferLogging method to stop logging.
	StopTransferLogging	Stops file transfer logging. When TransferLoggingEnabled is True (the default value), Reflection stores file transfer information to a log file specified by the TransferLogFileName property. Use StartTransferLogging method to start logging.
	TransmitFile	Transmits the specified file to the host. If the ReadTabAsSpaces property is True and the TransmitFilesOption.NoTranslation option is not specified, tab characters in the file are converted to spaces as they are transmitted to the host. If the ReadCtrlZAsEOF property is True and the TransmitFilesOption.NoTranslation option is not specified, a Ctrl+Z character in the file will terminate the method.
	WRQReceiveFile	Transfers one or more files from the host to the PC using the WRQ/Reflection file transfer protocol.
	WRQSendFile	Transfers one or more files from the PC to the host using the WRQ/Reflection file transfer protocol.
	WRQStartServer	Starts the WRQ/Reflection protocol host server in preparation for multiple file transfers. Most menu commands and all toolbar buttons are disabled when in server mode.
	WRQStopServer	Stops the WRQ/Reflection protocol host server started by WRQStartServer.
	XmodemReceiveFile	Transfers a file from the host to the PC, using the Xmodem file transfer protocol.
	XmodemSendFile	Transfers a file from the PC to the host, using the Xmodem file transfer protocol.
	ZmodemReceiveFile	Transfers one or more files from the host to the PC, using the Zmodem file transfer protocol.
	ZmodemSendFile	Transfers one or more files from the host to the PC, using the Zmodem file transfer protocol.

Top

Public Events

	Name	Description
	FileTransferDone	File transfer completed event.

Top

Reference

IFileTransfer Interface
Attachmate.Reflection.Emulation.OpenSystems Namespace

Send Feedback