BACnetConfTextMessage (FUN)

FUNCTION BACnetConfTextMessage : IEC_BACNET_STATUS

Sends an confirmed TextMessage.

Sends a request to transmit a text to the remote device. Message may be prioritized into Normal or Urgent categories. In addition, a text message may be optionally classified by a numeric class code or class identification string. The interpretation of the class is a local matter. This routine may control APDU properties like APDU length, segmentation, and timeout, for both request and response. This routine can execute asynchronously, so this routine will return to the caller before the BACnet reply is received so that the applications keeps 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 has to be provided by the BACnet application, will be used to process this information. If a number of asynchronous requests are sent, the responses will be queued and identified by the transaction handles. If application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine, then this routine sends a request and waits for reply.

InOut:

Scope	Name	Type	Comment
Return	BACnetConfTextMessage	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_TEXT_MESSAGE_INFO	A pointer to the service information data structure. This data structure of datatype BACNET_TEXT_MESSAGE_INFO contains an object Identifier of device object of the request initiator, a boolean if Message Class Present attribute, a message class, a message priority, a message string type and a message string.
	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.