SFTPConnectionErrorMessage Property

ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message.

Syntax

ANSI (Cross Platform)
char* GetSFTPConnectionErrorMessage(int iConnectionId);

Unicode (Windows)
LPWSTR GetSFTPConnectionErrorMessage(INT iConnectionId);
- (NSString*)SFTPConnectionErrorMessage:(int)connectionId;

#define PID_SFTPSERVER_SFTPCONNECTIONERRORMESSAGE 4

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SFTPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SFTPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

SFTPConnectionErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. If left blank, the class will set a default message based on the returned status code.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

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