OFTPConnectionMaxRecordSize Property

This value determines the maximum length for a record in the outgoing virtual file.

Syntax

 oftpserver.getOFTPConnectionMaxRecordSize(index, [callback])
 oftpserver.setOFTPConnectionMaxRecordSize(index,  OFTPConnectionMaxRecordSize, [callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getOFTPConnectionMaxRecordSize([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setOFTPConnectionMaxRecordSize([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When OFTPConnectionVirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

The index 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

Integer