wodSFTP API library - ServerErrorText Property
      
 

Description

Holds the error text returned by the server.


Return type

A Long value. If successful, 0 is returned, otherwise error as specified here.


Syntax

long Sftp_GetServerErrorText(void *Sftp, char *Buffer, int *Bufsize);

The ServerErrorText function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
char *Buffer Buffer that will hold the returned string.
int *Bufsize Size of the buffer.

Remarks

The ServerErrorText property holds the description of the last error that was returned by the server, and is only set by wodSFTP when it throws error 30018. If you try to read this information before error 30018 is thrown,it is likely to be invalid. We suggest that you read it from within the Done callback or, if you are working in Blocking mode, immediately after you get control back from wodSFTP.

Possible values are:

0 OK
1 End of file
2 No such file or folder
3 Permission denied
4 General failure
5 Bad message
6 No connection
7 Connection lost
8 Operation unsupported

The Bufsize variable should contain the maximum data length that can be stored in the Buffer variable. If you set Bufsize = 0, then the function will return with error ERROR_INSUFFICIENT_BUFFER and Bufsize will contain the required buffer size.