BACnetReadAllPropertyDataContents (FUN) ¶ FUNCTION BACnetReadAllPropertyDataContents : IEC_BACNET_STATUS Tries to read all property contained data at once. Sends one or more requests to read the value of a property of an object. This function is a convenience function. It tries to get the complete property contained data in different ways automatically so that the user application has not to implement special strategies and fallbacks here. InOut: Scope Name Type Comment Return BACnetReadAllPropertyDataContents IEC_BACNET_STATUS 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. pReadInfo POINTER TO IEC_BACNET_READ_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, and array index. 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. pContents POINTER TO IEC_BACNET_PROPERTY_CONTENTS Pointer to a property contents buffer structure. This data structure must contain a pointer to a buffer into which the value is copied. Upon successful completion, the contents IEC_BACNET_DATA_TYPE tag attribute indicates the datatype of the property. The buffer pointer in the property contents structure may be 0 along with the size. In this case the API will fill the buffer and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. 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.

BACnetReadFile (FUN) ¶ FUNCTION BACnetReadFile : IEC_BACNET_STATUS Sends an AtomicReadFile request. Sends a request to read the contents of the specified file beginning from the specified position. The file may be accessed as records or as a stream of octets that is defined by the contents of File_Access_Method property of the File object. Since the present version of this API does not support a default processing of this service, the user application has to include a Hook procedure to process it. This routine may 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 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_READ_FILE_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 application does not supply the BACNET_READ_FILE_COMPLETE_CB routine; then the BACnetReadFile routine sends a request and waits for reply. Asynchron call, which fills pResult with the call result in an asynchronus manner. As soon as pResultStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pResult is valid. InOut: Scope Name Type Comment Return BACnetReadFile 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. pReadInfo POINTER TO IEC_BACNET_READ_FILE_INFO A pointer to hold the request information data structure. This data structure contains the objectID, File Access Type ( IEC_BACNET_FILE_ACCESS_TYPE.FILE_ACCESS_STREAM or IEC_BACNET_FILE_ACCESS_TYPE.FILE_ACCESS_RECORD ) and Read File Range information. 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. pResult POINTER TO IEC_BACNET_READ_FILE_RESULT A pointer to a buffer to hold the response data if successful reading (datatype IEC_BACNET_READ_FILE_RESULT ). This pointer may be 0 if the asynchron call is used. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. 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.

BACnetReadProperty (FUN) ¶ FUNCTION BACnetReadProperty : IEC_BACNET_STATUS Sends a ReadProperty request Sends a request to read the value of a property of an object. This routine may send asynchronous messages, i.e. this routine will complete its execution before the BACnet reply comes so the applications can keep running. The response information will be received by an internal thread which is responsible for receiving asynchronous responses. An optional BACNET_READ_PROP_COMPLETE_CB routine, which is provided by the BACnet application, may be used to process this information. If a number of asynchronous requests are sent, the responses may be queued and identified by the application provided handles. If this routine does not use the BACNET_READ_PROP_COMPLETE_CB routine, then the BACnetReadProperty routine sends a request and waits for the reply. This routine may control APDU Properties like APDU length and segmentation and timeout, both during its execution and in response processing. Asynchron call, which fills pContents with the call result in an asynchronus manner. As soon as pContentsStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pContents is valid. InOut: Scope Name Type Comment Return BACnetReadProperty 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. pReadInfo POINTER TO IEC_BACNET_READ_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, and array index. 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. pContents POINTER TO IEC_BACNET_PROPERTY_CONTENTS Pointer to a property contents buffer structure. This data structure must contain a pointer to a buffer into which the value is copied. Upon successful completion, the contents IEC_BACNET_DATA_TYPE tag attribute indicates the datatype of the property. The buffer pointer in the property contents structure may be 0 along with the size. In this case the API will fill the buffer and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. 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.

BACnetReadPropertyMultiple (FUN) ¶ FUNCTION BACnetReadPropertyMultiple : IEC_BACNET_STATUS Sends an ReadPropertyMultiple request. Sends a request to read the values of one or more specified properties of one or more objects. This routine may read a single property of a single object, a list of properties of a single object, or any number of properties of any number of objects within one device. This routine may 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 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_READ_PROP_MUL_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_READ_PROP_MUL_COMPLETE_CB routine then the BACnetReadPropertyMultiple routine sends a request and waits for the reply. Asynchron call, which fills readAccessResult with the call result in an asynchronus manner. As soon as pContentsStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pContents is valid. InOut: Scope Name Type Comment Return BACnetReadPropertyMultiple 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. pRpmInfo POINTER TO IEC_BACNET_READ_MUL_INFO A pointer to the service 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pReadAccessResult POINTER TO IEC_BACNET_READ_RAW_RESULT_LIST A pointer to the memory block to place a list of one or more IEC_BACNET_READ_RAW_RESULT_LIST data structures which indicate success or failure of the reading of each specified Property. In the case of successful access to a single Property, its value shall be returned within this argument, and in the case of access failure this argument shall convey the Property Access Error information. The application may initialize the readRes member of the IEC_BACNET_READ_RAW_RESULT_LIST structure with a 0 pointer and setting the nListCount to 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. 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.

BACnetReadRange (FUN) ¶ FUNCTION BACnetReadRange : IEC_BACNET_STATUS Sends a ReadRange request Sends a request to read a specific range of data items representing a subset of data available within a specified object property. This routine may be used with any list or array of lists property. 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_READ_RANGE_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_READ_RANGE_COMPLETE_CB routine; then the BACnetReadRange routine sends a request and waits for reply. Asynchron call, which fills pResult with the call result in an asynchronus manner. As soon as pContentsStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pContents is valid. InOut: Scope Name Type Comment Return BACnetReadRange 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. pReadInfo POINTER TO IEC_BACNET_READ_RANGE_INFO A pointer to the service information data structure of datatype IEC_BACNET_READ_RANGE_INFO . 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. pResult POINTER TO IEC_BACNET_READ_RANGE_RESULT A pointer to a buffer to place the Result data if successful reading (datatype IEC_BACNET_READ_RANGE_RESULT ). The application may initialize the itemData member of the IEC_BACNET_READ_RANGE_RESULT struture with a 0 pointer and bufferSize with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. 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.

BACnetReinitializeDevice (FUN) ¶ FUNCTION BACnetReinitializeDevice : IEC_BACNET_STATUS Sends a reinitializeDevice request. Sends a message to instruct a remote Device to reboot itself (cold start) or reset itself (warm start). This routine may be used to execute setup/restore procedures. 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 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 BACnetReinitializeDevice routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetReinitializeDevice 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. pServiceInfo POINTER TO IEC_BACNET_REINIT_DEV_INFO A pointer to the service information data structure. The fields of this data structure include the Reinit Type ( IEC_BACNET_REINIT_TYPE.REINIT_COLDSTART or IEC_BACNET_REINIT_TYPE.REINIT_WARMSTART ), and a password. 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.

BACnetRemoveListElement (FUN) ¶ FUNCTION BACnetRemoveListElement : IEC_BACNET_STATUS Sends an Remove-List-Element request Sends a request to remove one or more list elements from an object property which is a list. 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_CHANGE_LIST_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_CHANGE_LIST_COMPLETE_CB routine then the BACnetRemoveListElement routine sends a request and waits for the reply. InOut: Scope Name Type Comment Return BACnetRemoveListElement 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. pRemoveInfo 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 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. 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.

BACnetSubscribeCOV (FUN) ¶ FUNCTION BACnetSubscribeCOV : IEC_BACNET_STATUS Sends an SubscribeCov request Sends a message to subscribe a COV client to receive COV notifications from a BACnet standard object, or cancel the existing subscription. If the standard object supports COV reporting, COV notification may be sent to one or more subscriber clients. A subscription establishes a connection between the change of value detection and reporting mechanism within the COV-server device, and a logical Process within a COV-client. 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 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 BACnetSubscribeCOV routine sends a request and waits for the reply. InOut: Scope Name Type Comment Return BACnetSubscribeCOV 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. pSubscriber POINTER TO IEC_BACNET_SUBSCRIBE_COV_INFO A pointer to a memory block which contains data structure defining a set of parameters: whether this request is for subscription or cancellation, the destination Process identifier, monitored object identifier, whether confirmed or unconfirmed notification is required, and subscription lifetime. 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.

BACnetSubscribeCOVProperty (FUN) ¶ FUNCTION BACnetSubscribeCOVProperty : IEC_BACNET_STATUS Sends an SubscribeCovProperty request Sends a message to subscribe a COV client to receive COV notifications for an arbitrary property in an arbitrary BACnet object, or to cancel an existing subscription. If the object supports COV reporting, COV notifications may be sent to one or more subscriber clients. A subscription establishes a connection between the change of value detection and reporting mechanism within the COV initiating object, and a logical process within the COV-client. This routine may control APDU Properties like APDU length and segmentation and timeout for both request and response processing. This routine may send asynchronous messages, i.e. this routine will complete its execution before the BACnet reply comes so 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 messages are sent, the responses shall be queued and identified by the transaction handles. If no BACNET_SIMPLE_ACK_COMPLETE_CB routine is used then BACnetSubscribeCOVProperty routine sends a request message and waits for the reply. NOTE : If fLifeTimePresent and fCovIncrementPresent of pSubscriber are not set to 1, on some systems errors may occur. However, these parameters can be 1 any time, because a liftime of 0 indicates infinite lifetime and an increment of 0 an infinitesimal small increment. InOut: Scope Name Type Comment Return BACnetSubscribeCOVProperty 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. pSubscriber POINTER TO IEC_BACNET_SUBSCRIBE_COVP_INFO A pointer to a memory block which contains data structure defining a set of parameters: whether this request is for subscription or cancellation, the destination Process identifier, monitored object identifier, monitored property reference, COV increment, whether confirmed or unconfirmed notification is required, and subscription lifetime. 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.

BACnetUnconfPrivateTransfer (FUN) ¶ FUNCTION BACnetUnconfPrivateTransfer : IEC_BACNET_STATUS Sends a UnconfirmedPrivateTransfer request. Sends a BACnet Unconfirmed-Private-Transfer service request to invoke proprietary or non-standard service in a remote device. return IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetUnconfPrivateTransfer 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_PRIVATE_TRANSFER_INFO A pointer to the service information data structure. This data structure is to transport the service parameters to the destination device.