wodSFTP API library - Compression Property
 Compression function
      
 

Description

Determines the level of compression used.


Return type

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


Syntax

long Sftp_GetCompression(void *Sftp, short *pVal);
 long Sftp_SetCompression(void *Sftp, short newVal);

The Compression function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
short *pVal, newVal An Integer value. Determines the level of compression.

Remarks

Before connecting to an SSH server, you can decide if you want to use wodSFTP's internal compression. If so, you should set the Compression property to any value between 1 and 9 (1 for minimum compression, 9 for maximum compression). If you don't want compression to be used, set this parameter to 0.

Typically, SFTP clients use compression level 6 for optimum performance.