pdcomm_gem_equipment_clear_data_variable

Function

Removes the cached value of one data variable.

PdcommStatus pdcomm_gem_equipment_clear_data_variable(PdcommTcpEndpoint *endpoint, uint32_t id)

Declared in: #include <pdcomm_gem_data.h>

Afterwards a report that needs this variable fails with #PDCOMM_INVALID_STATE unless a sample supplies the value.

Parameters

Name	Description
endpoint	Equipment endpoint.
id	Data variable ID (DVID).

Returns

#PDCOMM_OK on success, also when no value was cached; #PDCOMM_INVALID_ARGUMENT when endpoint is NULL; #PDCOMM_OUT_OF_RANGE when id is not defined; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment or has no data store; #PDCOMM_BACKPRESSURE or #PDCOMM_POISONED.