StartTransfer Event
Fired when a document starts transferring.
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(OFTPServerStartTransferEventParams *e);
typedef struct {
int ConnectionId;
int Direction;
char *LocalFile;
const char *VirtualFileName;
const char *VirtualFileDate;
const char *Destination;
const char *Originator; int reserved; } OFTPServerStartTransferEventParams; Unicode (Windows) virtual INT FireStartTransfer(OFTPServerStartTransferEventParams *e);
typedef struct {
INT ConnectionId;
INT Direction;
LPWSTR LocalFile;
LPCWSTR VirtualFileName;
LPCWSTR VirtualFileDate;
LPCWSTR Destination;
LPCWSTR Originator; INT reserved; } OFTPServerStartTransferEventParams;
- (void)onStartTransfer:(int)connectionId :(int)direction :(NSString**)localFile :(NSString*)virtualFileName :(NSString*)virtualFileDate :(NSString*)destination :(NSString*)originator;
#define EID_OFTPSERVER_STARTTRANSFER 15 virtual INT IPWORKSEDI_CALL FireStartTransfer(INT &iConnectionId, INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator);
Remarks
This event fires when a file transfer begins.
Direction specifies if the client or server sent the file.
| 0 (Client) | The file originated from the client. |
| 1 (Server) | The file originated from the server. |
VirtualFileName holds the filename.
VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".
Originator identifies the sender (SFID) code in the send file request.
Destination identifies the receiver (SFID) code in the send file request.
LocalFile holds the full path to the file that will be written.
ConnectionId identifies the connected client.