expression.ZmodemSendFile( _ ByVal localFile As String, _ ByVal remoteFile As String, _ ByVal transferOption As TransferTypeOption _ ) As ReturnCode
where expression is a variable that represents a FileTransfer Object
Parameters
- localFile
- Specifies a local file. This string can contain wildcard characters (to send multiple files).
- remoteFile
- Specifies a host file. This string cannot contain wildcard characters. If this string is empty or contains a path but no filename, the local filename is used to generate a host filename.
- transferOption
- A TransferTypeOption value that specifies the type of file 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) and 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. 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
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. |