BACnetReadFileObjectContents (FUN)ΒΆ

FUNCTION BACnetReadFileObjectContents : IEC_BACNET_STATUS

Function initiates a file data transfer to read the file object data.

This function will start a file data transfer to read the specified file object data in the specified device. In case of stream data in the specified file object the data is written in binary format as received. In case of record data in the file object the record is stored also in binary format but is may be extended by a record marker and record size.

Return: IEC_BACNET_STATUS

InOut:

Scope

Name

Type

Comment

Return

BACnetReadFileObjectContents

IEC_BACNET_STATUS

Input

pInfo

POINTER TO IEC_BACNET_FILEACCESS_INFO

Pointer to information which specifies which device and which file object will be accessed.

pICallback

CmpEventMgr.ICmpEventCallback

Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_FILEACCESS_PROGRESS. Purpose documented in BACstack: Pointer to the user application callback funktion to inform about failures and progress information during the data transfer procedure.

pAPDUParams

POINTER TO IEC_BACNET_APDU_PROPERTIES

A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL.

pTransactionToken

POINTER TO BACnetAsyncTransactionToken

Transaction token of the asynchronous call - see BACnetAsyncTransactionToken.