BACnetGetDeviceAddressBindingList (FUN)¶
FUNCTION BACnetGetDeviceAddressBindingList : IEC_BACNET_STATUS
Retrieves the entire array or one item of the array of ‘dynamic’ bound addresses.
This function may be used by an application to retrieve the complete or part of the array of the address bindings. Unresolved addresses will also be returned in the result in case the parameter bOnlyResolved is FALSE. They will have an global broadcast address (address.net will be set to ::BACNET_NETWORK_GLOBAL and address.len will be set to ::BACNET_MAC_BROADCAST_LENGTH).
Return: IEC_BACNET_STATUS
- InOut:
Scope
Name
Type
Comment
Return
BACnetGetDeviceAddressBindingList
Input
pContents
POINTER TO IEC_BACNET_PROPERTY_CONTENTS
A pointer to the property contents structure in which the list is stored. The application may initialize the buffer with NULL pointer and 0 size. In this case the API will allocate the neccessary buffer and the application has to release with a call to ::BACnetFreeStackAllocatedMemory if the buffer is no longer needed.
nIndex
Specifies which part of the array shall be retrieved. ::BACNET_ENTIRE_ARRAY will return all items in the array. ::BACNET_ARRAY_COUNT will return the buffer filled with an unsigned showing the number of entries in the array.
nCount
Specifies the maximum number of entries to return in the result starting at the given array position. In case of ::BACNET_ENTIRE_ARRAY this will return the first nCount entries.
bOnlyResolved
Specifies that unresolved entries shall NOT be reported in this list if set to TRUE.