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.
Input	`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!)!