Zone Control API > BS2_GetFireAlarmZoneStatus

BS2_GetFireAlarmZoneStatus

Retrieves the status of selected Fire Alarm zones.

Declaration

#include "BS_API.h"
 
int BS2_GetFireAlarmZoneStatus(void* context, uint32_t deviceId, uint32_t* zoneIds, uint32_t zoneIdCount, BS2ZoneStatus** zoneStatusObj, uint32_t* numZoneStatus);
See BS2ZoneStatus Structure

Parameter

  • [In] context : Context
  • [In] deviceId : Device ID
  • [In] zoneIds : List of Fire Alarm zone IDs to retrieve
  • [In] zoneIdCount : Size of Fire Alarm zone ID list
  • [Out] zoneStatusObj : Zone status list pointer
  • [Out] numZoneStatus : Number of zone status records

NOTE
The zoneStatusObj 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

BS2_GetFireAlarmZone
BS2_GetAllFireAlarmZone
BS2_GetAllFireAlarmZoneStatus
BS2_SetFireAlarmZone
BS2_SetFireAlarmZoneAlarm
BS2_RemoveFireAlarmZone
BS2_RemoveAllFireAlarmZone