Skip to content
Start free evaluation

pdcomm_gem_equipment_alarm_state

Function

Reads the alarm counts of the Equipment alarm store.

PdcommStatus pdcomm_gem_equipment_alarm_state(PdcommTcpEndpoint *endpoint, PdcommGemAlarmState *state)

Declared in: #include <pdcomm_gem_alarms.h>

Parameters

NameDescription
endpointEndpoint with a configured GEM Equipment and alarm store.
stateCaller storage; set state->struct_size before the call. Written only on success.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or state is NULL or state->struct_size is too small; #PDCOMM_INVALID_STATE when the endpoint has no GEM Equipment or no alarm store; #PDCOMM_POISONED when the endpoint is poisoned or a panic was contained.