pdcomm_gem_spool_capture_alarm
Function
Builds an S5F1 alarm report and offers it to the spool.
PdcommStatus pdcomm_gem_spool_capture_alarm(PdcommTcpEndpoint *endpoint, uint32_t alarm_id, uint8_t wait, uint64_t now, PdcommGemSpoolWriteInfo *info)The report uses the current state, category, and text of a registered, enabled alarm and is then captured as in pdcomm_gem_spool_capture().
Parameters
| Name | Description |
|---|---|
endpoint | Synchronized endpoint configured as GEM Equipment with a spool and alarms. |
alarm_id | ALID of the alarm. |
wait | 1 to store the S5F1 with the W bit; must be 0 or 1. |
now | Application timestamp stored as the capture time. |
info | Receives the outcome. Must not be NULL. |
Returns
As pdcomm_gem_spool_capture(); additionally #PDCOMM_INVALID_STATE when alarms are not configured or the alarm is unknown or disabled.