pdcomm_gem_equipment_data_at

Function

Reads the definition summary of one data variable by position.

PdcommStatus pdcomm_gem_equipment_data_at(PdcommTcpEndpoint *endpoint, size_t index, PdcommGemDataInfo *info)

Declared in: #include <pdcomm_gem_data.h>

Variables are enumerated in definition order.

Parameters

Name	Description
`endpoint`	Equipment endpoint.
`index`	Zero-based position.
`info`	Caller storage; set `info->struct_size` first. Known fields are zeroed before the endpoint is inspected.

Returns

#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when info is NULL or too small, or endpoint is NULL; #PDCOMM_OUT_OF_RANGE when index is not less than the variable count; #PDCOMM_BACKPRESSURE, #PDCOMM_INVALID_STATE (not an Equipment or no data store), or #PDCOMM_POISONED.