pdcomm_gem_result_event_value
Function
Copies one value of one report in a received S6F11.
PdcommStatus pdcomm_gem_result_event_value(const PdcommGemResult *result, size_t report_index, size_t value_index, PdcommSecsItem **out_item)Values carry no VIDs; position value_index corresponds to the VID at the same position in the report definition.
Parameters
| Name | Description |
|---|---|
result | Result with outcome #PDCOMM_GEM_EVENT_RECEIVED. |
report_index | Zero-based report position in the message. |
value_index | Zero-based value position in the report. |
out_item | Receives a new, independently owned item. Set to NULL first, so it is NULL after every failure. Must not be NULL. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when result or out_item is NULL; #PDCOMM_INVALID_STATE when result is not a received event report; #PDCOMM_OUT_OF_RANGE when either index is out of range; #PDCOMM_LIMIT_EXCEEDED, #PDCOMM_ALLOCATION_FAILED, or #PDCOMM_INTERNAL_ERROR.
Notes
- Ownership: release the item with pdcomm_secs_destroy(). It remains valid after the result, the TCP event, and the endpoint are destroyed.