BACNET_READ_FILE_RESULT_RECORD (STRUCT)¶

TYPE BACNET_READ_FILE_RESULT_RECORD : STRUCT

Describes the structure in which an AtomicReadFile response is returned.

The Read File Result data (data type BACNET_READ_FILE_RESULT) contains the result of reading. This data type contains a boolean End Of File parameter which indicates does the response include the last octet of the file, Access Type field, and a number of fields which describe the memory block containing the file contents. In the Stream case there are a Start Position field and an Octet String field. In the Record case there are a Start Record Number field, a Record Count field that indicates a number of records to read, and a Buffer field. The buffer is formatted as an array of BACNET_OCTET_STRING values which represent the records. The Start position and start record counts begin from zero. If the Octet String field or Buffer field is not big enough to hold the actual result, a BACNET_STATUS_OUT_OF_SPACE reply will be returned.

InOut:

Name	Type	Comment
startRecord	IEC_BACNET_SIGNED	This parameter, of type INTEGER, represents the number of records from the beginning of the file from which the start of the data was read. A ‘File Start Record’ of 0 is the first record of the file.
retRecordCount	IEC_BACNET_UNSIGNED	This parameter, of type Unsigned, represents the number of records that were actually read from the file, which may be less than the ‘Requested Record Count’.
recordData	IEC_BACNET_BUFFER	This parameter consists of a List of OCTET STRINGs that contain the requested file data.