StartTransfer Event

Fired when a file starts downloading/uploading.

Syntax

ANSI (Cross Platform)
virtual int FireStartTransfer(SCPStartTransferEventParams *e);
typedef struct {
int Direction;
const char *LocalFile;
const char *RemoteFile;
const char *RemotePath;
char *FilePermissions; int reserved; } SCPStartTransferEventParams; Unicode (Windows) virtual INT FireStartTransfer(SCPStartTransferEventParams *e);
typedef struct {
INT Direction;
LPCWSTR LocalFile;
LPCWSTR RemoteFile;
LPCWSTR RemotePath;
LPWSTR FilePermissions; INT reserved; } SCPStartTransferEventParams;
- (void)onStartTransfer:(int)direction :(NSString*)localFile :(NSString*)remoteFile :(NSString*)remotePath :(NSString**)filePermissions;
#define EID_SCP_STARTTRANSFER 11

virtual INT IPWORKSSSH_CALL FireStartTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile, LPSTR &lpszRemotePath, LPSTR &lpszFilePermissions);

Remarks

The StartTransfer event fires when the file starts transferring.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The LocalFile, RemoteFile, and RemotePath parameters provide information about the current transfer.

The FilePermissions parameter may be used to set the remote file permissions on file currently being uploaded. It will also be populated with the current permissions of the remote file when downloading. See FilePermissions for more details.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Edition - Version 20.0 [Build 8501]