BACnetObjectBase.GetPropertyInstanceStackAllocContentBuffer (METH)

METHOD GetPropertyInstanceStackAllocContentBuffer : CmpBACnet.IEC_BACNET_STATUS

Gets the value/content of a specified BACnet-Property (ePropertyID) independend of any client side acces restrictions. The specified index should be set to CmpBACnet.CONSTANT.BACNET_ENTIRE_ARRAY, meaning that all elements of a List or Array in a BACnet-Property are retrieved. Otherwise an index counting from 1 specifies a element of a BACnetARRAY property. The IEC_BACNET_PEROPERTY_CONTENTS variable propertyContents.Buffer.pBuffer is requested to be initialized with 0, whereas the stack allocates the latter pointer. Consequently after using the information in propertyContents.Buffer.pBuffer has to be used to freed. DeallocStackAllocatedContentBuffer provides convenient dealloc for stack allocated propertyContents.

InOut:

Scope

Name

Type

Comment

Return

GetPropertyInstanceStackAllocContentBuffer

CmpBACnet.IEC_BACNET_STATUS

Input

ePropertyID

CmpBACnet.IEC_BACNET_PROPERTY_ID

The id of the property to get.

nIndex

CmpBACnet.IEC_BACNET_ARRAY_INDEX

Counting from 1. See documentation of CmpBACnet.BACnetRetrievePropertyInstance.

Inout

propertyContents

CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS

structure holding the read Property-Data (see documentation above).