~~NOTOC~~
[[zone_control_api]] > [[BS2_GetTimedAntiPassbackZone]]

----

===== BS2_GetTimedAntiPassbackZone =====
Retrieves selected timed Anti Passback zones.
==== Declaration ====
<code cpp>
#include "BS_API.h"

int BS2_GetTimedAntiPassbackZone(void* context, uint32_t deviceId, uint32_t* zoneIds, uint32_t zoneIdCount, BS2TimedAntiPassbackZone** zoneObj, uint32_t* numZone);
</code>

<callout type="info">
[[zone control api#BS2TimedAntiPassbackZone|See BS2TimedAntiPassbackZone Structure]]
</callout>
==== 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
<WRAP indent>
<WRAP info 70%>
**NOTE**\\
The zoneObj variable needs to return the memory to the system by the [[BS2_ReleaseObject]] function after being used. 
</WRAP>
</WRAP>
==== 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 ====
[[BS2_GetAllTimedAntiPassbackZone]]\\ [[BS2_GetTimedAntiPassbackZoneStatus]]\\ [[BS2_GetAllTimedAntiPassbackZoneStatus]]\\ [[BS2_SetTimedAntiPassbackZone]]\\ [[BS2_SetTimedAntiPassbackZoneAlarm]]\\ [[BS2_RemoveTimedAntiPassbackZone]]\\ [[BS2_RemoveAllTimedAntiPassbackZone]]\\ [[BS2_ClearTimedAntiPassbackZoneStatus]]\\ [[BS2_ClearAllTimedAntiPassbackZoneStatus]]