pdcomm_gem_equipment_update_data_variable

Function

Replaces the cached value of one data variable.

PdcommStatus pdcomm_gem_equipment_update_data_variable(PdcommTcpEndpoint *endpoint, uint32_t id, const PdcommSecsItem *value)

Declared in: #include <pdcomm_gem_data.h>

Allowed at any time, including while communicating. The value is copied after its format, count, item limits, and the store's value byte budget are checked; on failure the old cache is kept.

Parameters

Name	Description
endpoint	Equipment endpoint.
id	Data variable ID (DVID).
value	New value; must have the declared format and a count in the declared range.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or value is NULL or the value has the wrong format or count; #PDCOMM_OUT_OF_RANGE when id is not defined; #PDCOMM_LIMIT_EXCEEDED when the value exceeds the item limits or max_value_bytes; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment or has no data store; #PDCOMM_BACKPRESSURE, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_POISONED.