oftp_connection_virtual_file_format Property
The structure of the outgoing or incoming file.
Syntax
def get_oftp_connection_virtual_file_format(connection_id: int) -> int: ... def set_oftp_connection_virtual_file_format(connection_id: int, value: int) -> None: ...
Default Value
0
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 class expects the file to be in text format with each line containing the max_record_size 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 max_record_size. When using this format, the class 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 max_record_size characters. |
Note: When either oftp_connection_virtual_file_security_level has been set to a value other than slNone or oftp_connection_compress has been set to true, all files become ffUnstructured except ffVariable files.
The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.