BACnetWhoIs (FUN) ¶ FUNCTION BACnetWhoIs : IEC_BACNET_STATUS Sends a who-Is request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWhoIs 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. filterMin IEC_BACNET_INST_NUMBER Argument limit the lower range of Device instance numbers which shall respond to this request. The range is omitted if the value is set to ::BACNET_NO_FILTER. filterMax IEC_BACNET_INST_NUMBER Argument limit the upper range of Device instance numbers which shall respond to this request. The range is omitted if the value is set to ::BACNET_NO_FILTER.
BACnetWriteAllPropertyDataContents (FUN) ¶ FUNCTION BACnetWriteAllPropertyDataContents : IEC_BACNET_STATUS Tries to write all given property data contents at once so the application does not need to handle different errors and use fallbacks to bypass this errors (like breaking down array or lists into their elements to transmit them). Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWriteAllPropertyDataContents 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_WRITE_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.
BACnetSubscribeCOVProperty (FUN) ¶ FUNCTION BACnetSubscribeCOVProperty : IEC_BACNET_STATUS Sends an SubscribeCovProperty request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSubscribeCOVProperty 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_SUBSCRIBE_COVP_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.
BACnetSubscribeCOVPropertyMultiple (FUN) ¶ FUNCTION BACnetSubscribeCOVPropertyMultiple : IEC_BACNET_STATUS Sends an SubscribeCovPropertyMultiple request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSubscribeCOVPropertyMultiple 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_SUBSCRIBE_COVP_MUL_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information. pSubsError POINTER TO IEC_BACNET_SUBSCRIBE_MUL_ERROR_INFO In case of any interrupted service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.
BACnetUnconfPrivateTransfer (FUN) ¶ FUNCTION BACnetUnconfPrivateTransfer : IEC_BACNET_STATUS Sends a UnconfirmedPrivateTransfer request. 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 a data structure which contains all service parameters this service provides and the application needs to process.
BACnetBackupBACnetDevice (FUN) ¶ FUNCTION BACnetBackupBACnetDevice : IEC_BACNET_STATUS Function initiates a backup for an BACnet device. This function will start an backup procedure for the specified device. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetBackupBACnetDevice IEC_BACNET_STATUS Input pInfo POINTER TO IEC_BACNET_BACKUPRESTORE_INFO Pointer to information which specifies which device should be restored and where the file object data should be stored to be backuped. pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_BACKUPRESTORE_PROGRESS . Purpose documented in BACstack: Pointer to the user application callback funktion to inform about failures and progress information during the procedure execution. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken .
BACnetCloseClientCustomer (FUN) ¶ FUNCTION BACnetCloseClientCustomer : IEC_BACNET_STATUS Closes an advanced BACnet client customer handle. The user application should call this API function to release all ressources of the advanced BACnet client API. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetCloseClientCustomer IEC_BACNET_STATUS Input hCustomer IEC_BACNET_HANDLE An handle to an created advanced BACnet client customer created by ::BACnetOpenClientCustomer.
BACnetGetClientDeviceCommunication (FUN) ¶ FUNCTION BACnetGetClientDeviceCommunication : IEC_BACNET_STATUS Retrieves the current device communication control value for the specified device. The user application can request the current communication enable state for registered devices. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetClientDeviceCommunication IEC_BACNET_STATUS Input devId IEC_BACNET_INST_NUMBER The device instance number for which communication needs to be requested. A value of 0xFFFFFFFF will retrieve the global communication enable / disable state. pDccValue POINTER TO IEC_BACNET_DCC_VALUE A pointer to hold the requested communication state which is filled by the API.
BACnetWriteFile (FUN) ¶ FUNCTION BACnetWriteFile : IEC_BACNET_STATUS Sends an AtomicWriteFile request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWriteFile 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_WRITE_FILE_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pResult POINTER TO IEC_BACNET_WRITE_FILE_RESULT This parameter points to an memory location in which the service result will be stored. pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.
BACnetWriteGroup (FUN) ¶ FUNCTION BACnetWriteGroup : IEC_BACNET_STATUS Sends an unconfirmed WriteGroup request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWriteGroup 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_WRITE_GROUP_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process.