BACnetLifeSafetyOperation (FUN)

FUNCTION BACnetLifeSafetyOperation : IEC_BACNET_STATUS

Sends a LifeSafetyOperation request. Sends the requests to provide a mechanism for transporting specific instructions from an operator to silence, audible or visual notification appliances or reset notification appliances. This service may be used in fire, life safety and security systems. Because the present version of this BACnet API does not support a default processing for this service, the destination has to include a Hook procedure to process it. This routine may control APDU properties like APDU length, segmentation and timeout for both requests and responses. This routine can execute asynchronously, so this routine will return to the caller before the BACnet reply is received so that the application keeps running. In this case the response information will be received by the thread that is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which has to be provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses will be queued and identified by their transaction handles. If the application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine, then this routine sends a request and waits for reply. return IEC_BACNET_STATUS

InOut:

Scope

Name

Type

Comment

Return

BACnetLifeSafetyOperation

IEC_BACNET_STATUS

Input

pSourceAddress

POINTER TO IEC_BACNET_ADDRESS

If the BACnet application has only one device constructed and installed, this can be NULL. 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.

pServiceInfo

POINTER TO IEC_BACNET_LIFE_SAFETY_INFO

A pointer to hold the request information data structure.

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 NULL if the application isn’t interested in detailed error information.