Skip to content
Start free evaluation

pdcomm_gem_host_request_enabled_alarm_list

Function

Sends S5F7 List Enabled Alarm Request (W=1) from a Host.

PdcommStatus pdcomm_gem_host_request_enabled_alarm_list(PdcommTcpEndpoint *endpoint, PdcommTcpToken *out_token)

Declared in: #include <pdcomm_gem_alarms.h>

The Equipment replies with S5F8 listing only the alarms whose reporting is enabled. The reply yields a RESPONSE result with outcome #PDCOMM_GEM_ENABLED_ALARM_LIST_RECEIVED.

Parameters

NameDescription
endpointEndpoint with a configured GEM Host.
out_tokenReceives the transaction token; zero after every failure.

Returns

#PDCOMM_OK when the request was queued (queue acceptance only); #PDCOMM_INVALID_ARGUMENT when endpoint or out_token is NULL; #PDCOMM_INVALID_STATE when the endpoint has no GEM Host, communication is not COMMUNICATING, or the HSMS session is not selected; #PDCOMM_BACKPRESSURE when a TCP event is staged, all 32 pending slots are busy, or the TCP queue is full or stopping; #PDCOMM_LIMIT_EXCEEDED or #PDCOMM_ALLOCATION_FAILED; #PDCOMM_POISONED when the endpoint is poisoned or a panic was contained; or another TCP submission status, as for pdcomm_tcp_request().