Skip to content
Start free evaluation

pdcomm_gem_host_enable_events

Function

Sends an Enable/Disable Event Report request (S2F37) from a Host.

PdcommStatus pdcomm_gem_host_enable_events(PdcommTcpEndpoint *endpoint, uint8_t enabled, const uint32_t *event_ids, size_t count, PdcommTcpToken *out_token)

Declared in: #include <pdcomm_gem_reports.h>

An empty ID list applies the change to every event on the Equipment, linked or not. The S2F38 reply arrives as #PDCOMM_GEM_RESPONSE with request kind #PDCOMM_GEM_ENABLE_EVENTS, outcome #PDCOMM_GEM_ENABLE_EVENTS_ACK, and the ERACK in acknowledgement.

Parameters

NameDescription
endpointHost endpoint.
enabled1 to enable (CEED true) or 0 to disable; other values are invalid.
event_idsArray of count CEIDs. May be NULL when count is 0.
countNumber of CEIDs; 0 selects all events.
out_tokenZeroed first; receives the transaction token on success. Must not be NULL.

Returns

The same statuses as pdcomm_gem_host_define_reports(); #PDCOMM_INVALID_ARGUMENT also when enabled is greater than 1.