BACnetAddListElement (FUN)

FUNCTION BACnetAddListElement : IEC_BACNET_STATUS

Sends an Add-List-Element request.

Sends an Add-List-Element request to add one or more list elements to an object property which is a list. This routine sends Add-List-Element request using address instead of device handle to identify destination device. This routine allows to control APDU properties like APDU length and segmentation and timeout for both request and response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the application can keep running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_CHANGE_LIST_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous service requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply BACNET_CHANGE_LIST_COMPLETE_CB, then the BACnetAddListElement routine sends a request and waits for the reply.

InOut:

Scope

Name

Type

Comment

Return

BACnetAddListElement

IEC_BACNET_STATUS

A status indicating if the operation worked.

Input

pSourceAddress

POINTER TO IEC_BACNET_ADDRESS

If the BACnet application has only one device constructed and installed, this can be 0. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction.

pDestinationAddress

POINTER TO IEC_BACNET_ADDRESS

This is the MAC address of the device to which the request should be sent.

pAddInfo

POINTER TO IEC_BACNET_CHANGE_LIST_INFO

A pointer to the service information data structure. This data structure contains the objectID, ePropertyID, nIndex and a buffer in which the Property Contents datatype list is placed.

pAPDUParams

POINTER TO IEC_BACNET_APDU_PROPERTIES

A pointer to the APDU-Properties structure which sets APDU properties for this transaction only. This does not change global defaults or settings for the application APDU Properties. This argument may be NULL. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request.

pTransactionToken

POINTER TO BACnetAsyncTransactionToken

Transaction token of the asynchronous call - see BACnetAsyncTransactionToken.

pError

POINTER TO IEC_BACNET_ERROR

A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

pFirstFailed

POINTER TO IEC_BACNET_UNSIGNED

A pointer to a buffer in which to place the sequence number of the first element in the pElements list which cannot be added to the property. pFirstFailed may be 0.