pdcomm_gem_equipment_report_value
Function
Resolves the current value of one report VID from local stores only.
PdcommStatus pdcomm_gem_equipment_report_value(PdcommTcpEndpoint *endpoint, uint32_t vid, PdcommSecsItem **out_item)Uses the binding store, or legacy status resolution when none is installed, and the data variable cache; no samples are applied. This does not preflight a whole wire report. The returned item uses the item limits of its source store.
Parameters
| Name | Description |
|---|---|
endpoint | Equipment endpoint. |
vid | Variable ID (VID) as used in reports. |
out_item | Receives an independent copy of the value; set to NULL first. Must not be NULL. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint or out_item is NULL; #PDCOMM_OUT_OF_RANGE when the VID is unbound or its source does not exist; #PDCOMM_INVALID_STATE when the endpoint is not an Equipment, or the VID is bound to a data variable with no cached value or there is no data store; #PDCOMM_BACKPRESSURE, #PDCOMM_LIMIT_EXCEEDED, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_POISONED.
Notes
- Ownership: release the item with pdcomm_secs_destroy().