RemotePath Property

The current path in the SFTP server.

Syntax

ANSI (Cross Platform)
char* GetRemotePath();
int SetRemotePath(const char* lpszRemotePath); Unicode (Windows) LPWSTR GetRemotePath();
INT SetRemotePath(LPCWSTR lpszRemotePath);
@property (nonatomic,readwrite,assign,getter=remotePath,setter=setRemotePath:) NSString* remotePath;
- (NSString*)remotePath;
- (void)setRemotePath:(NSString*)newRemotePath;
#define PID_SFTP_REMOTEPATH 37

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 RemotePath shows the current working directory on the SFTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of RemotePath.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

Setting RemotePath causes the class to send the appropriate command to the remote server only if connected.

Example (Changing Directory)


SFTPControl.Logon()
SFTPControl.RemotePath = "/home/user"

Data Type

String

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