Syntax

InputRecordStream.ReadRecord( record, mapping = "")

Return Value

Long

Returns 0 if a record was successfully read. Returns non-zero if end of file was encountered before reading a record.

Purpose

Read the next record from the stream.

Parameters

record As PropertyObject

[In/Out] Specifies where to store the incoming record. The record parameter may be a container, array, or string. If it is a container, the container represents the record, and each subproperty is a field. If the record parameter is an array, the array represents the record, and each array element is a field. If the record parameter is a string, the fields are written to the string as a comma-separated list.

mapping As String

[In] Specifies the mapping to elements (subproperties or array elements) in the record parameter from fields in the InputRecordStream . Mapping is not supported if the record parameter is a string. The mapping is a comma-separated list of index ranges. For example, "0, 3-5, 8-7" specifies that fields from the incoming record be stored to elements 0, 3, 4, 5, 8, and 7 of the container or array. The last range in the list may be open-ended. For example, "2, 3-" specifies that fields from the incoming record be written to elements 2, 3, and all elements beyond 3 of the container or array. If the record parameter is a container, the range list may include individual subproperty names. For example, "Temperature, Pressure, 0-1" specifies that fields from the incoming record be written to the subproperties "Temperature" and "Pressure" followed by elements 0 and 1. For convenience, you may specify an empty string to specify all elements be written in order. That is, an empty string is equivalent to "0-". The default value is an empty string.

This parameter has a default value of "" .

See Also

CsvFileInputRecordStream.ReadRecord

InputRecordStream.ReadRecordTo