Back to product page

PutDataLen function


Stores data from a fixed-size buffer to a remote file.

Type

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

Syntax

  • C
long Sftp_PutDataLen(void *Sftp, void *Data, int DataLen, char *RemoteFile);
The PutDataLen(void *Sftp,void *Data,int DataLen,char *RemoteFile) syntax has these parts:
void *SftpHandle of the created Sftp instance.
void *DataRepresents data that will be stored on the server.
int DataLenLength of the data buffer.
char *RemoteFileFull path to a file on the server.

Remarks

Unlike the PutFile function that copies a local file to the server, PutData will copy the contents of the Data buffer to the specified file on the server. This is a very handy feature for small files that are stored in local variables within your programs. Although there is no size limit on sending data to the server this way, you should try to keep data below 64kb.

What will PutData do for you? It will copy the contents of a specified variable to a temporary file on a local disk (in a temporary folder) and then copy that file to the server. Keep in mind that for this method you *MUST* allow the component to write to your disk. If you are using wodSFTP in an environment such as ASP, make sure that the Guest user has sufficient privileges to create temporary files.

Once the file has been created and sent to the server, it will be deleted from the local disk.

Platforms

Windows