LocalFile Property

The location of the local file.


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

IPWORKSS3_EXTERNAL void* IPWORKSS3_CALL IPWorksS3_S3Client_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSS3_EXTERNAL int IPWORKSS3_CALL IPWorksS3_S3Client_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value



This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

Data Type


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