IPWorks EDI 2020 C++ Builder Edition

Questions / Feedback?

OFTPConnectionVirtualFileFormat Property

The structure of the outgoing or incoming file.

Syntax

__property TibeOFTPServerOFTPConnectionVirtualFileFormats OFTPConnectionVirtualFileFormat[int ConnectionId] = { read=FOFTPConnectionVirtualFileFormat, write=FSetOFTPConnectionVirtualFileFormat };
enum TibeOFTPServerOFTPConnectionVirtualFileFormats { ffUnstructured=0, ffText=1, ffFixed=2, ffVariable=3 };

Default Value

ffUnstructured

Remarks

The structure of the outgoing or incoming file.

When sending files, set this property to specify the format to apply to outgoing files.

When receiving files, query this property to determine the structure of the file received from the client.

The following values are valid file formats for outgoing virtual files:

0 (Unstructured - default) The outgoing file is binary and has not structure. There are no records in this type of file.
1 (Text) The outgoing file is a text file that consists of lines containing no more than 2048 characters terminated by CRLF. This type contains no records.
2 (Fixed) The outgoing file is in fixed file format, which means all records are of the same length. For fixed files, the component expects the file to be in text format with each line containing the MaxRecordSize characters terminated by a CRLF.
3 (Variable) The outgoing file is a variable file format, meaning all records are of variable length and are no longer than MaxRecordSize. When using this format, the component will parse out each record as a line terminated by CRLF. Thus, this type of file must be a text file, and must contain lines with less than MaxRecordSize characters.

Note: When either OFTPConnectionVirtualFileSecurityLevel has been set to a value other than slNone or OFTPConnectionCompress has been set to true, all files become ffUnstructured except ffVariable files.

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

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 C++ Builder Edition - Version 20.0 [Build 8203]