BACnetRetrievePropertyInstanceByHandle
(FUN)
FUNCTION BACnetRetrievePropertyInstanceByHandle : IEC_BACNET_STATUS
Same function as BACnetRetrievePropertyInstance but uses handle to object instead of an device instance number and object idenfier.
- InOut:
Scope
Name
Type
Comment
Return
BACnetRetrievePropertyInstanceByHandle
Input
handleToObject
A valid handle to the object retrieved by a call to BACnetGetObjectHandle.
ePropertyID
The Property identifier of the local property.
nIndex
The index of an array item. If the Property is not an array, the index value BACNET_VOID_INDEX (-1) should be used. If the Property is an array, the index value BACNET_ENTIRE_ARRAY (-1) can be used to write the entire array. If the Property is an array, the index value BACNET_ARRAY_COUNT (0) can be used to resize the array provided that this array can be variable size. The indices of BACnet arrays start counting at 1.
pVal
POINTER TO IEC_BACNET_PROPERTY_CONTENTS
Pointer to a Property Contents containing a buffer into which to copy the value. Upon successful completion of this routine, the Property Contents tag attribute indicates the type of the Property. The application may initialize the buffer size with 0 and pointer with NULL. In this case the API will allocate the memory needed to store the value and the application must release it.