BACnetWriteProperty (FUN)

FUNCTION BACnetWriteProperty : IEC_BACNET_STATUS

Sends a WriteProperty request

Sends a request to write a value to a property of an object. This routine may control APDU properties like APDU length, segmentation, and timeout for both request and in response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications 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_SIMPLE_ACK_COMPLETE_CB routine, which is provided by the application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine; then the routine sends a request and waits for the reply.

Asynchron call. As soon as pResultStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the call was successfully completed.

InOut:

Scope

Name

Type

Comment

Return

BACnetWriteProperty

IEC_BACNET_STATUS

A status indicating whether 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.

pWriteInfo

POINTER TO IEC_BACNET_WRITE_INFO

A pointer to the service information data structure. This data structure identifies the property within the device and includes the object ID, property ID array index and also a property contents buffer with the value to be written.

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 0. 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.