expression.WRQSendFile( _ ByVal localFile As String, _ ByVal remoteFile As String, _ ByVal transferType As TransferTypeOption, _ ByVal fileExists As DestinationFileExistsOption, _ ByVal before As Date, _ ByVal since As Date, _ ByVal exclude As String, _ ByVal attributes As String _ ) As ReturnCode
where expression is a variable that represents a FileTransfer Object
Parameters
- localFile
- Specifies a local file. This string can contain PC wildcard characters (to transfer multiple files).
- remoteFile
- Specifies a host file. This string cannot contain wildcard characters. If this string is an empty string (""), the local filename is used to generate the host filename. You can also append "switches" to the host filename to modify the way the file is handled during the transfer.
- transferType
- A TransferTypeOption value that specifies what type of file is being transferred. 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.AutoDetect File transfer type is determined by the file extension. Use these properties to determine which file extensions are linked to which transfer type: TransferAutoDetectDefaultType TransferAutoDetectASCIIExtensionList TransferAutoDetectBinaryExtensionList TransferAutoDetectImageLabelsExtensionList TransferAutoDetectScanExtensionList TransferTypeOption.Image Host to host Image/Labels transfer (Labels is a valid synonym).
- fileExists
- A DestinationFileExistsOption value that 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 filename 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 filenames can include wildcards.
- attributes
- Specifies host file attributes to be used.
Return Value
One of the following ReturnCode enumerated values.
Member | Description |
---|---|
Cancelled | Cancelled. |
Error | Error. |
PermissionRequired | Permission is required. |
Success | Success. |
Timeout | Timeout condition. |
Truncated | The text is truncated. |