InfoConnect API Guide
Attachmate.Reflection.Emulation.OpenSystems Namespace / IFileTransfer Interface / WRQReceiveFile Method
Specifies a local file. This string can be empty or can contain just drive and path information, in which case the host file name is used to generate a local file name. This string cannot contain wildcard characters.
Specifies a host file. This string can contain wildcard characters (to transfer multiple files). The wildcard characters must be appropriate for the host system. You can also append "switches" to the host file name to modify the way the file is handled during the transfer.
TransferTypeOption.ASCII: Specifies ASCII file transfer. InfoConnect applies the ASCII File Translation options (as specified on the Translation tab in the File Transfer Setup dialog box) to the data in the file as it is transferred. TransferTypeOption.Binary Specifies binary file transfer. Data in the file is not translated as it is transferred. TransferTypeOption.Image Host to host Image/Labels transfer (rcLabels is a valid synonym).
Specifies what to do if the file already exists on the host. The possible values are: DestinationFileExistsOption.AskUser Prompts the user to specify what should be done. DestinationFileExistsOption.Cancel Stops the transfer. DestinationFileExistsOption.Update Performs the transfer only if the host file is newer than the PC file. DestinationFileExistsOption.Delete Deletes (overwrites) the existing file. DestinationFileExistsOption.Append Appends the contents of the host file to the existing PC file. DestinationFileExistsOption.Rename 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. DestinationFileExistsOption.Skip Skips the file (the transfer does not take place, but no error results).
Specifies a date and time. Only host files created or modified before the specified date and time are transferred.
Specifies a date and time. Only host files created or modified after the specified date and time are transferred.
Specifies one or more files to be excluded from a wildcard transfer. The file names can include wildcards.


In This Topic
    WRQReceiveFile Method
    In This Topic
    Transfers one or more files from the host to the PC using the WRQ/Reflection file transfer protocol.
    Syntax
    'Declaration
     
    
    Function WRQReceiveFile( _
       ByVal localFile As String, _
       ByVal remoteFile As String, _
       ByVal transferOption As TransferTypeOption, _
       ByVal fileOption As DestinationFileExistsOption, _
       ByVal before As Date, _
       ByVal since As Date, _
       ByVal exclude As String _
    ) As ReturnCode
    'Usage
     
    
    Dim instance As IFileTransfer
    Dim localFile As String
    Dim remoteFile As String
    Dim transferOption As TransferTypeOption
    Dim fileOption As DestinationFileExistsOption
    Dim before As Date
    Dim since As Date
    Dim exclude As String
    Dim value As ReturnCode
     
    value = instance.WRQReceiveFile(localFile, remoteFile, transferOption, fileOption, before, since, exclude)

    Parameters

    localFile
    Specifies a local file. This string can be empty or can contain just drive and path information, in which case the host file name is used to generate a local file name. This string cannot contain wildcard characters.
    remoteFile
    Specifies a host file. This string can contain wildcard characters (to transfer multiple files). The wildcard characters must be appropriate for the host system. You can also append "switches" to the host file name to modify the way the file is handled during the transfer.
    transferOption
    TransferTypeOption.ASCII: Specifies ASCII file transfer. InfoConnect applies the ASCII File Translation options (as specified on the Translation tab in the File Transfer Setup dialog box) to the data in the file as it is transferred. TransferTypeOption.Binary Specifies binary file transfer. Data in the file is not translated as it is transferred. TransferTypeOption.Image Host to host Image/Labels transfer (rcLabels is a valid synonym).
    fileOption
    Specifies what to do if the file already exists on the host. The possible values are: DestinationFileExistsOption.AskUser Prompts the user to specify what should be done. DestinationFileExistsOption.Cancel Stops the transfer. DestinationFileExistsOption.Update Performs the transfer only if the host file is newer than the PC file. DestinationFileExistsOption.Delete Deletes (overwrites) the existing file. DestinationFileExistsOption.Append Appends the contents of the host file to the existing PC file. DestinationFileExistsOption.Rename 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. DestinationFileExistsOption.Skip Skips the file (the transfer does not take place, but no error results).
    before
    Specifies a date and time. Only host files created or modified before the specified date and time are transferred.
    since
    Specifies a date and time. Only host files created or modified after the specified date and time are transferred.
    exclude
    Specifies one or more files to be excluded from a wildcard transfer. The file names can include wildcards.
    See Also