InfoConnect for Unisys
ZmodemReceiveFile Method


Specifies the local file name to use for the file. This string can contain drive and path information. It can also be just a folder name or an empty string, in which case the host file name is used to generate a local file name. This string cannot contain wildcard characters.
Specifies the remote file name to use for the file.
Specifies what type of file is being transferred. The default is TransferTypeOption.Binary. The possible values are: TransferTypeOption.ASCII Specifies an ASCII file transfer. If the XmodemTranslateCharacters 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 XmodemTranslateCharacters 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. TransferTypeOption.Binary Binary file transfer. Data in the file is not translated as it is transferred.
Specifies what to do if the sent file already exists on the PC. The default is DestinationFileExistsOption.Cancel. The possible values are: DestinationFileExistsOption.AskUser Prompts the user to specify what should be done. DestinationFileExistsOption.Cancel Stops the transfer. DestinationFileExistsOption.Delete Deletes (overwrites) the existing file. DestinationFileExistsOption.Append Appends the data to the existing file. DestinationFileExistsOption.Rename Renames the file being transferred if a file of the same name already exists on the destination system. The last three characters of the existing file's name are changed to 001. If such a file already exists, the file's name is changed to 002, and so on, up to 999. DestinationFileExistsOption.Resume Resumes a canceled receive. If the file already exists on the PC, InfoConnect assumes it is there as the result of an aborted transfer. InfoConnect therefore resumes the transfer at the point of interruption. DestinationFileExistsOption.Update Performs the transfers only if the host file is newer than the PC file. DestinationFileExistsOption.UseRemote Uses the IfFileExists option specified by the remote system. If the remote system doesn't specify an IfFileExists , this option is equivalent to DestinationFileExistsOption.Cancel.
Transfers one or more files from the host to the PC, using the Zmodem file transfer protocol.
Syntax
'Declaration
 
Function ZmodemReceiveFile( _
   ByVal localFile As String, _
   ByVal remoteFile As String, _
   ByVal transferOption As TransferTypeOption, _
   ByVal fileOption As DestinationFileExistsOption _
) As ReturnCode
'Usage
 
Dim instance As IFileTransfer
Dim localFile As String
Dim remoteFile As String
Dim transferOption As TransferTypeOption
Dim fileOption As DestinationFileExistsOption
Dim value As ReturnCode
 
value = instance.ZmodemReceiveFile(localFile, remoteFile, transferOption, fileOption)

Parameters

localFile
Specifies the local file name to use for the file. This string can contain drive and path information. It can also be just a folder name or an empty string, in which case the host file name is used to generate a local file name. This string cannot contain wildcard characters.
remoteFile
Specifies the remote file name to use for the file.
transferOption
Specifies what type of file is being transferred. The default is TransferTypeOption.Binary. The possible values are: TransferTypeOption.ASCII Specifies an ASCII file transfer. If the XmodemTranslateCharacters 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 XmodemTranslateCharacters 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. TransferTypeOption.Binary Binary file transfer. Data in the file is not translated as it is transferred.
fileOption
Specifies what to do if the sent file already exists on the PC. The default is DestinationFileExistsOption.Cancel. The possible values are: DestinationFileExistsOption.AskUser Prompts the user to specify what should be done. DestinationFileExistsOption.Cancel Stops the transfer. DestinationFileExistsOption.Delete Deletes (overwrites) the existing file. DestinationFileExistsOption.Append Appends the data to the existing file. DestinationFileExistsOption.Rename Renames the file being transferred if a file of the same name already exists on the destination system. The last three characters of the existing file's name are changed to 001. If such a file already exists, the file's name is changed to 002, and so on, up to 999. DestinationFileExistsOption.Resume Resumes a canceled receive. If the file already exists on the PC, InfoConnect assumes it is there as the result of an aborted transfer. InfoConnect therefore resumes the transfer at the point of interruption. DestinationFileExistsOption.Update Performs the transfers only if the host file is newer than the PC file. DestinationFileExistsOption.UseRemote Uses the IfFileExists option specified by the remote system. If the remote system doesn't specify an IfFileExists , this option is equivalent to DestinationFileExistsOption.Cancel.
See Also