KermitReceiveFile method
Programming with Reflection
KermitReceiveFile method
Syntax object.KermitReceiveFile LocalFile, RemoteFile, [TransferType], [IfFileExists]
Transfers one or more files from a remote computer running a Kermit program to the local computer, using the Kermit file transfer protocol.
LocalFile Argument Type: String
Required
Specifies a local file. This string can contain drive and path information. It can also be just a folder name, in which case the remote file name is used to generate a local file name. This string cannot contain wildcard characters. If this string is empty (""), the remote filename is used to generate a local filename.
RemoteFile Argument Type: String
Required
Specifies a file on the remote system. This string can contain wildcard characters. If this string is empty (""), the filename must be specified by the remote Kermit program.
TransferType Argument Type: Enumeration
Optional
Specifies what type of file is being transferred. If this argument is omitted, the default is rcBinary. The rcBinary option is generally appropriate for most transfers, including transfers from bulletin boards. Use rcASCII when you're sure you want characters translated. The possible values are:
rcASCII
Specifies an ASCII file transfer. If the KermitTranslateCharacters property is set to True, the following translations are performed:
· Character set translations (as specified on the Emulation tab in the Terminal Setup dialog box).
· Relevant ASCII File Translation options (as specified on the Translation tab in the File Transfer Setup dialog box).
If KermitTranslateCharacters is set to False, record separator characters may still be translated to carriage return/linefeed sequences (if the ConvertSeparatorToEOL property is set to True), and a Ctrl+Z character may still be appended to the end of the file (if the WriteCtrlZAsEOF property is set to True), but no other translations are performed.
rcBinary
Specifies a binary file transfer. Data in the file is not translated as it is transferred.
IfFileExists Argument Type: Enumeration
Optional
Specifies what to do if the received file already exists on the PC. If this argument is omitted and the local file exists, the transfer fails (equivalent to rcCancel). The possible values are:
rcAskUser
Prompts the user to specify what to do.
rcCancel
Stops the transfer.
rcDelete
Deletes (overwrites) the existing file.
rcAppend
Appends the data to the existing file.
rcRename
Renames the file being transferred. The existing file retains the original name. The last three characters of the file being transferred are changed to 001. If such a file already exists, the file's name is changed to 002, and so on, up to 999.
Keyword Index
Related Topics