LocalFile Property

The path to a local file for upload/download.

Syntax

ANSI (Cross Platform)
char* GetLocalFile();
int SetLocalFile(const char* lpszLocalFile); Unicode (Windows) LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);
@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;
- (NSString*)localFile;
- (void)setLocalFile:(NSString*)newLocalFile;
#define PID_SFTP_LOCALFILE 32

IPWORKSSFTP_EXTERNAL void* IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

The LocalFile property is used by the Upload and Download methods. The file will only be overwritten if the Overwrite property is set to True.

Example (Setting LocalFile)


SFTPControl.Localfile = "C:\localfile.txt"
SFTPControl.RemoteFile = "remotefile.txt"
SFTPControl.Download()

SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()

Data Type

String

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