ApplicationSoftwareVersion.PostStartBACnetStack (METH) ¶ METHOD PostStartBACnetStack : UDINT InOut: Scope Name Type Return PostStartBACnetStack UDINT

BACnetSchedule.AddWeeklyEntry (METH) ¶ METHOD AddWeeklyEntry : CmpBACnet.IEC_BACNET_STATUS Adds a weekly entry to the Weekly_Schedule-Property of this BACnet-Object For now dont use this to add weekly entries with complex type, otherwise GetWeeklyEntry will refuse to get those entries. Please see comment on GetWeeklyEntry related to complex data types. InOut: Scope Name Type Comment Return AddWeeklyEntry CmpBACnet.IEC_BACNET_STATUS Input tim TIME The time of the weekly entry to add. value CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The value corresponding to the entry. dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week of the weekly entry to add.

BACnetSchedule.GetWeeklyEntry (METH) ¶ METHOD GetWeeklyEntry : CmpBACnet.IEC_BACNET_STATUS Gets the weekly entry for a specific day dayOfWeek at the index nIndex in the Weekly_Schedule-Property of this BACnet-Object. There are two options how to deal with the content buffer (value). 1.) the caller provides the content buffer large enough to hold the content. This works just for plain content data, because otherwise the caller can not determine the needed size of the content buffer a-priori. In case the content is of complex data type, GetWeeklyEntry returns BACNET_STATUS_INVALID_VALUE. 2.) stack allocated content buffer For this option provide value.buffer.pBuffer = 0 and free the stack allocated content buffer after usage FreeStackAllocatedMemory(value.buffer.pBuffer) Choosing one of the options, please be aware, that the Weekly_Schedule-Property of your Schedule object might be writable, so clients can add weekly entries of complex type even if your application isn’t doing so. InOut: Scope Name Type Comment Return GetWeeklyEntry CmpBACnet.IEC_BACNET_STATUS Input dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for which to get a weekly entry. nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the entry of the week day to get. Output tim TIME The time of the entry after calling the method. Inout value CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The value of the entry after calling this method. The value.buffer.pBuffer has to have an allocated memory, which fits the data’s needs (is at least allocated big enough!)!

BACnetSchedule.AddExceptionWeekAndDay (METH) ¶ METHOD AddExceptionWeekAndDay : CmpBACnet.IEC_BACNET_STATUS Adds a week and day entry (i.e. weekly at day) to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionWeekAndDay CmpBACnet.IEC_BACNET_STATUS Input month CmpBACnet.IEC_BACNET_MONTH The month of the exception date. weekOfMonth CmpBACnet.IEC_BACNET_WEEK_OF_MONTH The week of the month of the exception date. dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week of the exception date. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the week and day dates which correspond to the exception date. entryCount CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of times and values for the exceptions. eventPriority BYTE The priority with which the values are written.

BACnetSchedule.GetExceptionEntry (METH) ¶ METHOD GetExceptionEntry : CmpBACnet.IEC_BACNET_STATUS Gets a entry with index nIndex of the Exception_Schedule-Property of this BACnet-Object. The returned data (pSpecialEvt) is allocated by the stack and therefore has to be freed after usage using FreeStackAllocatedMemory again! InOut: Scope Name Type Comment Return GetExceptionEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the exception entry to get. Output pSpecialEvt POINTER TO CmpBACnet.IEC_BACNET_SPECIAL_EVENT The returned Pointer gets filled with the data of IEC_BACNET_EVENT_PARAMETER AND (!) the data referenced within evtParams. After usage, use FreeStackAllocatedMemory , to free the used memory again.

BACnetSchedule.AddPropertyReference (METH) ¶ METHOD AddPropertyReference : CmpBACnet.IEC_BACNET_STATUS Adds device object property reference to the List_Of-Object_Property_References-Property (which lists all the Objects to influenced by this Schedule) of this BACnet-Object. InOut: Scope Name Type Initial Comment Return AddPropertyReference CmpBACnet.IEC_BACNET_STATUS Input deviceInstance CmpBACnet.IEC_BACNET_DWORD The BACnet device to reference. objInstance CmpBACnet.IEC_BACNET_DWORD The BACnet object instance number of the BACnet device to reference. objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The BACnet object type number of the BACnet device to reference. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The BACnet property ID of the BACnet object to reference. nIndex CmpBACnet.IEC_BACNET_SIGNED The 1 based index to reference of the BACnet property. xDevicePresent BOOL TRUE Whether the BACnet device is present or not.

BACnetSchedule.GetPropertyReference (METH) ¶ METHOD GetPropertyReference : CmpBACnet.IEC_BACNET_STATUS Gets the device object property reference at index nIndex in the List_Of-Object_Property_References-Property of this BACnet-Object. InOut: Scope Name Type Comment Return GetPropertyReference CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT The 1 based index of the reference to get. Output devObjPropRef CmpBACnet.IEC_BACNET_DEV_OBJ_PROP_REFERENCE The object property reference gotten after a call to this method.

BACnetSchedule.GetWeeklyEntryCount (METH) ¶ METHOD GetWeeklyEntryCount : CmpBACnet.IEC_BACNET_STATUS Gets the number of weekly entries for a specific day dayOfWeek in the Weekly_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return GetWeeklyEntryCount CmpBACnet.IEC_BACNET_STATUS Input dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for which the entry count shall be determined. Output count CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of entries for the specified week day after calling this method.

BACnetSchedule.GetWeeklySchedule (METH) ¶ METHOD GetWeeklySchedule : CmpBACnet.IEC_BACNET_STATUS Gets the Weekly_Schedule of this BACnet object. The returned pointer pWeeklySchedule is allocated with the corresponding data, whereas the user has to use FreeStackAllocatedMemory, to free the allocated memory after data usage. InOut: Scope Name Type Comment Return GetWeeklySchedule CmpBACnet.IEC_BACNET_STATUS Output pWeeklySchedule POINTER TO CmpBACnet.IEC_BACNET_DAILY_SCHEDULE The returned Pointer gets filled with the data of the Priority Array AND (!) the data referenced within the array (i.e. strings, etc.). After usage, use FreeStackAllocatedMemory , to free the used memory.

BACnetSchedule.RemoveWeeklyEntry (METH) ¶ METHOD RemoveWeeklyEntry : CmpBACnet.IEC_BACNET_STATUS Removess a weekly entry for a specific day dayOfWeek at the index nIndex in the Weekly_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Initial Comment Return RemoveWeeklyEntry CmpBACnet.IEC_BACNET_STATUS Input dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week for which n entry shall be removed. nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT 0 The 1 based index of the entry to remove.