eSE_DRLCGetLoadControlEvent

teSE_DRLCStatus eDRLCGetLoadControlEvent(
    uint8 u8SourceEndPointId,
    uint8 u8TableIndex,
    teSE_DRLCEventList eEventList,
    tsSE_DRLCLoadControlEvent **ppsLoadControlEvent);

Description

This function can be used to obtain an LCE from a local LCE list.

The required list must be specified as one of ‘Scheduled’, ‘Active’, ‘Cancelled’ and ‘Deallocated’. The index of the required LCE in the list must also be specified. The index of zero is used to indicate that the LCE with the oldest start-time should be retrieved. To retrieve all the LCEs in a list, repeatedly call this function with index zero until the function indicates that there are no further LCEs in the list (returns E_SE_DRLC_EVENT_NOT_FOUND).

Parameters

  • u8SourceEndPointId: Number of the local endpoint from which the LCE is to be retrieved (endpoint corresponding to the DRLC cluster)

  • u8TableIndex: Index of required LCE in the specified LCE list (see below)

  • eEventList: LCE list from which the LCE is to be retrieved, one of:

    • E_SE_DRLC_EVENT_LIST_SCHEDULED

    • E_SE_DRLC_EVENT_LIST_ACTIVE

    • E_SE_DRLC_EVENT_LIST_CANCELLED

    • E_SE_DRLC_EVENT_LIST_DEALLOCATED

  • ppsLoadControlEventPointer to a pointer to a tsSE_DRLCLoadControlEvent structure to receive the obtained LCE (see Section 41.11.1)

Returns

Any relevant DRLC return code listed in Section 41.9 or ZCL return code listed in Section 7.2

Parent topic:Functions