ServiceRequestRaw.RawData (PROP) ¶ PROPERTY RawData : ProtocolDataUnit When assigning this property, the data from the given PDU will be copied into the buffer managed by this request object.

override ¶ DoFinish (Method)

ServiceRequestRaw.DoFinish (METH) ¶ METHOD PROTECTED DoFinish : UDINT InOut: Scope Name Type Comment Return DoFinish UDINT Input xDestroyOnly BOOL Output pduContent ProtocolDataUnit Only evaluated in case of xDestroyOnly == FALSE

ServiceResponse (FB) ¶ FUNCTION_BLOCK ServiceResponse Properties: ContentData ContentSize Header Reader Methods: Create CreatePDU Destroy FB_Exit prvAnalyzeHeaderObsolete Structure: ContentData (Property) ContentSize (Property) Create (Method) CreatePDU (Method) Destroy (Method) FB_Exit (Method) Header (Property) Reader (Property) private prvAnalyzeHeaderObsolete (Method)

ServiceResponse.ContentData (PROP) ¶ PROPERTY ContentData : POINTER TO BYTE Returns a pointer to the content of the response, ie. without the according header information. This property can be only used after the method Create was called.

ServiceResponse.ContentSize (PROP) ¶ PROPERTY ContentSize : __UXINT Returns the size of the data pointer to by ContentData . This property can be only used after the method Create was called.

BACnetClientAPI ¶ Functions for directly accessing BACnet client functionalities of the BACnet component on the runtime system. BACnetAcknowledgeAlarm (Function) BACnetAddListElement (Function) BACnetCancelPendingConfirmedRequest (Function) BACnetConfPrivateTransfer (Function) BACnetConfTextMessage (Function) BACnetCreateObject (Function) BACnetCreateObjectResult (Struct) BACnetDeleteObject (Function) BACnetDeviceCommControl (Function) BACnetGetAlarmSummary (Function) BACnetGetEnrollmentSummary (Function) BACnetGetEventInfo (Function) BACnetLifeSafetyOperation (Function) BACnetReadAllPropertyDataContents (Function) BACnetReadFile (Function) BACnetReadProperty (Function) BACnetReadPropertyMultiple (Function) BACnetReadRange (Function) BACnetReinitializeDevice (Function) BACnetRemoveListElement (Function) BACnetSubscribeCOV (Function) BACnetSubscribeCOVProperty (Function) BACnetUnconfPrivateTransfer (Function) BACnetUnconfTextMessage (Function) BACnetWhoHas (Function) BACnetWhoIs (Function) BACnetWriteFile (Function) BACnetWriteGroup (Function) BACnetWriteProperty (Function) BACnetWritePropertyMultiple (Function) advanced BACnetBackupBACnetDevice (Function) BACnetCloseClientCustomer (Function) BACnetGetClientDeviceCommunication (Function) BACnetOpenClientCustomer (Function) BACnetRegisterClientCommunicationStateCallback (Function) BACnetRegisterClientDataPoint (Function) BACnetRegisterClientEventNotification (Function) BACnetRegisterClientUnsubscribeCompletionCallback (Function) BACnetRestartAllClients (Function) BACnetRestoreBACnetDevice (Function) BACnetSetClientDeviceCommunication (Function) BACnetSetClientDeviceFixAddress (Function) BACnetSetClientDeviceFixSubscribeCovTime (Function) BACnetSetClientGlobalCommTimingParameters (Function) BACnetSetClientGlobalMaxDeviceActions (Function) BACnetUnregisterClientDataPoint (Function) BACnetUnregisterClientEventNotification (Function)

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.

BACnetAcknowledgeAlarm (FUN) ¶ FUNCTION BACnetAcknowledgeAlarm : IEC_BACNET_STATUS Sends an AcknowledgeAlarm request. Sends a message to the initiating device to acknowledge that the operator has seen and responded to the event notification that required the acknowledgment. This routine may acknowledge either Confirmed Event Notification or Unconfirmed Event Notification requests. This routine allows to control APDU properties like APDU length, 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_SIMPLE_ACK_COMPLETE_CB routine, which is provided by the BACnet 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 BACnetAcknowledgeAlarm routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetAcknowledgeAlarm 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. pAckAlarmParams POINTER TO IEC_BACNET_ACK_ALARM_INFO A pointer to the memory block which contains a number of acknowledgement parameters: a process identifier to recognize a notification to which this acknowledgement is responding, an event object’s identifier, an event state, a time stamp to identify the event notification that is acknowledging, the identifier of operator or process that is acknowledging this event notification, and the time this acknowledgement was issued. 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.

BACnetCancelPendingConfirmedRequest (FUN) ¶ FUNCTION BACnetCancelPendingConfirmedRequest : IEC_BACNET_STATUS This function can be used by an BACnet application to cancel pending confirmed transactions directly which would take a long time to terminate if they would terminate by normal APDU retries and timeouts. If the application cancels such an transaction the transactions completion function <b>WILL NOT BE CALLED</b>. InOut: Scope Name Type Comment Return BACnetCancelPendingConfirmedRequest IEC_BACNET_STATUS Input pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken .