Error Event

Information about errors during data delivery.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireError(SFTPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  const char *LocalFile;
  const char *RemoteFile;
  int reserved;
} SFTPErrorEventParams;

Unicode (Windows)
virtual INT FireError(SFTPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  LPCWSTR LocalFile;
  LPCWSTR RemoteFile;
  INT reserved;
} SFTPErrorEventParams;

- (void)onError:(int)errorCode :(NSString*)description :(NSString*)localFile :(NSString*)remoteFile;

#define EID_SFTP_ERROR 6

virtual INT IPWORKSSSH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile);

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LocalFile identifies the local file. RemoteFile is the remote file.