VirtualFileFormat Property

The structure of the outgoing file.

Object Oriented Interface

public function getVirtualFileFormat();
public function setVirtualFileFormat($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 50 );
ipworksedi_oftpclient_set($res, 50, $value );

Default Value

0

Remarks

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 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 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 MaxRecordSize characters.

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

This property is not available at design time.

Data Type

Integer

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