Upload Method

Upload a file specified by LocalFile to an SFTP server.

Syntax

ANSI (Cross Platform)
int Upload();

Unicode (Windows)
INT Upload();
- (void)upload;
#define MID_SFTP_UPLOAD 26

IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

If you want to append to a server file, please refer to the Append method.

Example (Upload a File)


FTPControl.LocalFile = "C:\\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Upload()

FTPControl.LocalFile = "C:\\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Upload()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]