OFTPConnectionCompress Property

Whether or not compression is used on the outgoing or incoming file.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetOFTPConnectionCompress(int iConnectionId);
int SetOFTPConnectionCompress(int iConnectionId, int bOFTPConnectionCompress);

Unicode (Windows)
BOOL GetOFTPConnectionCompress(INT iConnectionId);
INT SetOFTPConnectionCompress(INT iConnectionId, BOOL bOFTPConnectionCompress);

- (BOOL)OFTPConnectionCompress:(int)connectionId;
- (void)setOFTPConnectionCompress:(int)connectionId:(BOOL)newOFTPConnectionCompress;

#define PID_OFTPSERVER_OFTPCONNECTIONCOMPRESS 8

IPWORKSEDI_EXTERNAL void* IPWORKSEDI_CALL IPWorksEDI_OFTPServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_OFTPServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSEDI_EXTERNAL int IPWORKSEDI_CALL IPWorksEDI_OFTPServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

FALSE

Remarks

Whether or not compression is used on the outgoing or incoming file.

When sending files to the client, if Compress is true the file will be compressed.

When receiving files, query this property to determine whether the file received from the client was compressed or not.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

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

This property is not available at design time.

Data Type

Boolean