Zone Control API > BS2_GetTimedAntiPassbackZone


Retrieves selected timed Anti Passback zones.

Declaration

#include "BS_API.h"
 
int BS2_GetTimedAntiPassbackZone(void* context, uint32_t deviceId, uint32_t* zoneIds, uint32_t zoneIdCount, BS2TimedAntiPassbackZone** zoneObj, uint32_t* numZone);

Parameter

  • [In] context : Context
  • [In] deviceId : Device ID
  • [In] zoneIds : List of timed Anti Passback zone IDs to retrieve
  • [In] zoneIdCount : Size of timed Anti Passback zone list
  • [Out] zoneObj : Timed Anti Passback zone list pointer
  • [Out] numZone : Number of timed Anti Passback zones

NOTE
The zoneObj variable needs to return the memory to the system by the BS2_ReleaseObject function after being used.

Return Value

If successfully done, BS_SDK_SUCCESS will be returned.
If there is an error, the corresponding error code will be returned.

See Also