FormatInputBuffer

Allows the user to configure the format of data that is received from the ReadCCLinkBitBuffer, ReadCCLinkWordBuffer, ReadDeviceNetBuffer, ReadEIPBuffer, ReadModbusBuffer, ReadProfinetBuffer, ReadMC and ReadUserDataBuffer functions. For more information, see ReadCCLinkBitBuffer, ReadCCLinkWordBuffer, ReadDeviceNetBuffer, ReadEIPBuffer, ReadModbusBuffer, ReadProfinetBuffer, ReadMC, or ReadUserDataBuffer.

When FormatInputBuffer is selected from the Insert Function Dialog, the Format Input Buffer dialog is automatically opened and used to program the function.

FormatInputBuffer Inputs

Syntax: FormatInputBuffer(Format)

Parameter	Description
Format	Specifies the Data Type and Element Size (in bytes) to automatically configure. Note: The maximum length for input data, when using Modbus TCP, EIP or PROFINET communications, is 4,000 bytes. When using SLMP or SLMP Scanner and iQ-R/Q/L Series or iQ-F Series is the selected Controller Type, the maximum length for input data is 1920 bytes. When using SLMP or SLMP Scanner and FX Series is the selected Controller Type, the maximum length for input data is 128 bytes. The maximum length for all other communications is 256 bytes.

Parameter

Description

Format

Specifies the Data Type and Element Size (in bytes) to automatically configure.

Note: The maximum length for input data, when using Modbus TCP, EIP or PROFINET communications, is 4,000 bytes. When using SLMP or SLMP Scanner and iQ-R/Q/L Series or iQ-F Series is the selected Controller Type, the maximum length for input data is 1920 bytes. When using SLMP or SLMP Scanner and FX Series is the selected Controller Type, the maximum length for input data is 128 bytes. The maximum length for all other communications is 256 bytes.

FormatInputBuffer Outputs

Returns

A Buffer data structure containing the formatted data or #ERR if any of the input parameters are invalid.