InfoConnect for Airlines
XmodemReceiveFile Method


Specifies the local file name to use for the file. This string can contain drive and path information. This string cannot contain wildcard characters.
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 contents of the host file to the existing PC file.
Transfers a file from the host to the PC, using the Xmodem file transfer protocol.
Syntax
'Declaration
 
Function XmodemReceiveFile( _
   ByVal localFile As String, _
   ByVal transferOption As TransferTypeOption, _
   ByVal fileOption As DestinationFileExistsOption _
) As ReturnCode
'Usage
 
Dim instance As IFileTransfer
Dim localFile As String
Dim transferOption As TransferTypeOption
Dim fileOption As DestinationFileExistsOption
Dim value As ReturnCode
 
value = instance.XmodemReceiveFile(localFile, transferOption, fileOption)

Parameters

localFile
Specifies the local file name to use for the file. This string can contain drive and path information. This string cannot contain wildcard characters.
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 contents of the host file to the existing PC file.
See Also